%SLIDESHOWSTART%

A Taste of TWiki

A Wiki is like a web site, except that you can edit the content in your browser

• "Wiki" is short for "wiki wiki", the Hawaiian word for "Quick"
• The idea originates from Macintosh Hypercard, via Ward Cunningham
• In Ward's words, Wiki is "the simplest online database that could possibly work"
• A Wiki is basically a shared, online, persistent whiteboard

TWiki Wiki

• Anyone can add content
  ... or change what is written
  ... or change the organisation of the content
• Whatever you write is
  ... nicely presented
  ... remembered... and never forgotten

TWiki also acts as an "application platform" to integrate a number of other functions.

TWiki is an Open-Source development on TWiki.org

• led by TWiki:Main.PeterThoeny
• with over 100 regular contributors in many countries

Where is it used?

• Examples: Disney, British Telecom, SAP, Wind River, Motorola, Epic Games
  

A number of public Wiki sites also use TWiki

• Examples:
  https://twiki.cern.ch/twiki/bin/view/
  http://wiki.java.net/bin/view/Javapedia/WebHome

TWiki Features

• TWiki pages are fully revision controlled, so a record of every change to every page is kept

  r6 < r5 < r4

• The look-and-feel is highly configurable, through use of templates

A "plugins" interface eases customisation extension application integration

Applications of basic TWiki

• A whiteboard
• A document repository
• A collaborative authoring environment
• A notebook / scrapbook
• A chat room

Extended applications

• A Content Management System (CMS) for websites
• A presentation development tool
• A Blog
• A database
• A project management system
• A tracking tool
• (truth is, we don't really know its limits!)

Structure of a TWiki page

• A header
• A body
• A footer

• The header and the footer are generated by the system
• The body contains the text of the page, as entered by you

The Page Header

	MyCo.MyTopic	Webs: Myco | Main | TWiki | Sandbox
	Changes | Index | Search | Go

• Changes - gives you a list of recent changes
• Index - gives you a full index
• Search - takes you to a search page, where you can search all the text
• Go - lets you type in the name of a page you already know

The Page Header ... continued

	MyCo.MyTopic	Webs: Myco | Main | TWiki | Sandbox
	Changes | Index | Search | Go

• For example, we might have a web called "Enemies", where we keep all we know about our enemies, and another called "Friends"
• There's usually a safe play web called something like "Sandbox" or "Scratch", where you can create pages just to try things out
• And some admin areas, like "Main" and "TWiki"

The Page Footer

• The Edit link takes you to an interactive page where you can change the page content
• The Attach link lets you attach files
• The other links invoke other, more complex, functions, mainly to do with revision tracking - they can safely be ignored for now

Editing Pages

• You've read a page, and you disagree with it violently! It says:
  Everyone knows that the world is an OblateSpheroid
  But you know for a fact it is flat! ;-)
• You've clicked the edit link, and an edit page has appeared. But it doesn't look much like what was on the page before - it's full of strange hieroglyphics!

• Now what?

What's in a page

• The hieroglyphics are what's known as "TWiki Markup" or "formatting"
• They are a really simple way of telling the browser how you want the page to look
• You don't have to use them
  • TWiki understands pages in plain text just fine.
    
    Actually it is perfectly and absolutely flat
    
    appears as
    
    Actually it is perfectly and absolutely flat

Formatting just makes pages prettier

• A full description of all the formatting can be found in the TextFormattingRules and TextFormattingFAQ
• The best thing to do is just to type until you get stuck
  • then follow the link on the edit page to the help.

Commonly used formatting

• ---+ indicates a heading. Add more +'s for a deeper heading.

  You type	You see
  ---+ This is a heading	This is a heading
  ---++ And so is this	And so is this

• %TOC% will insert a table of contents
  

More common formatting

• A blank line gives a paragraph break
  
• --- on a line of its own gives a horizontal bar
• Text in stars *like this* looks like this
  
• Text in underscores _like this_ looks like this
  
• Text in equals signs =like this= looks like this
  
• Bulleted lists use three spaces followed by an asterisk (*) at the start of the line
  • The depth of the bullet is given by the number of spaces, in multiples of three

• Numbered lists use a number in place of the *. The list is numbered automatically, so you can just use a 1

Even more.....

• You can create a table using vertical bars:

     | Cat | Feline |
     | Bear | Ursine |
     | Wolf | Lupine |

• appears as

  Cat	Feline
  Bear	Ursine
  Wolf	Lupine

• %RED% .... %ENDCOLOR% will change the colour of the enclosed text. Lots of colours are available (%RED%, %GREEN%, %BLUE% etc)

WikiWords

• One special hieroglyph that is very important is a BumpyWord
  • a word that starts with uppercase, then some lowercase, then more uppercase (a.k.a CamelCase)
• This has a special meaning to TWiki; if it matches the name of another topic, TWiki will automatically create a link to that page for you.
• If there is no such page, then the word is highlighted with a red-link, LikeThis
• If you click on the red-link, then TWiki will invite you to create that page.

• This lets you enter the names of topics you think should exist, but don't yet
  • You, or someone else, can always come along later and click on the red-link!

Referencing other pages and URLs

• BumpyWords automatically link to the target page
  • You can make these links easier to read using square brackets:
    • [[BumpyWords][bumpy words]] appears as bumpy words
• An ordinary URL pasted into text will appear as a link - http://www.google.com
  • You can also prettify URLs using square brackets:
    • [[http://www.google.com/][Google]] appears as Google
• Use %SEARCH. This is an interface to a sophisticated search engine that embeds the results of the search in your page. See TWikiVariables for full details.

More formatting

• There's lots more formatting available, see TextFormattingRules and TextFormattingFAQ
• If you are a real masochist, you can even enter raw HTML tags!
• Important to disable unwanted formatting, use <nop>
  • <nop>_word_ appears as _word_

Creating new pages

• Alternative ways:
  • Click on the red-link of a BumpyWord
  • Type in the name of the topic in the "Jump" box
  • Type in the name of the topic in the URL
• Any time you try to visit a page that doesn't exist, TWiki will invite you to create it.
• Make sure the names of topics are always BumpyWords.

Attachments

• Attachments are files which have been uploaded and attached to a TWiki page using the 'Attach' function in the footer.

Attachment	Action	Size	Date	Who	Comment
myco.gif	manage	9.6 K	13 Feb 2004 - 18:41	MushroomMagicMan	Attached image file

• Attachments are simply files, in whatever format you want.
• TWiki recognises some file formats, notably image files (.gif)
  • Write %ATTACHURL%/myco.gif to see this:

Wiki Culture

• What can I edit?
  • Anything. But it's good etiquette to sign your contributions
  • If someone doesn't want you to edit a page, it's up to them to say so, clearly, on the page
• But what if somebody doesn't like my edits?
  • In TWiki, they can always recover the old revision and re-instantiate it if they really want to
  • Otherwise they should regard your changes as an opportunity for discussion
• Pages in wiki are (usually) in one of three "modes"
  • DocumentMode
  • ThreadMode
  • StructuredMode

DocumentMode

• A page in DocumentMode usually comprises a contribution which is written in the third person and left unsigned.
• The piece of text is community property
  • It may have multiple and changing authors as it is updated to reflect the community consensus.

ThreadMode

• Thread mode is a form of discussion where the community holds a conversation
• The discussion usually starts out with a statement, at the top of the page, that is subsequently discussed
• The page may be periodically "refactored" (edited) to remove some of the comments
  • As long as the comment is accurately reflected in what replaces it, nobody usually minds.
  • Remember to always maintain a complete list of contributors, though!

• ThreadMode is rather like an e-mail thread
  • Except that new comments are usually added to the end
• ThreadMode pages often get refactored into DocumentMode

StructuredMode

• A page in StructuredMode follows some predefined structure for example
  • An agenda
  • A set of meeting minutes
  • A requirement description.
• Pages in StructuredMode will usually have rules governing how they are edited.

Other Wiki tricks - Categories

• A Wiki trick for grouping pages together
• Example: to group together a set of pages all relating to the weather:
  1. Create a page called 'CategoryWeather'
  2. Put a SEARCH that contains the word 'CategoryWeather' into it
     • %SEARCH{"CategoryWeather" nosearch="on" nosummary="on"}%
  3. Put the BumpyWord 'CategoryWeather' on all the pages relating to the weather
     (usually at the bottom, below a horizontal bar)

Contributed features

Here's a brief description of some of the more common plugins, together with the tags you might expect to see in topics if they are used. You can find out more by visiting the plugin pages.

• AutoCompletePlugin: Auto-complete for input fields of forms
• CalendarPlugin: Show a monthly calendar with highlighted events %CALENDAR...%
• CommentPlugin: Support rapid entry of short comments (also known as blogging) %COMMENT...
• ChartPlugin: Create PNG or GIF charts to visualize data in TWiki tables %CHART...
• EditTablePlugin: Edit TWiki tables using edit fields and drop down boxes %EDITTABLE...
• InterwikiPlugin: Define shortcuts for links to common external sites

More plugins

• RenderListPlugin: Render bullet lists in a variety of formats %RENDERLIST...
• SlideShowPlugin: Create web based presentations based on topics with headings %SLIDESHOWSTART...
• SpreadSheetPlugin: Add spreadsheet calculations like "$SUM( $ABOVE() )" to tables located in TWiki topics %CALC...
• TablePlugin: Control presentation and sorting of tables %TABLE...
• TWikiDrawPlugin: Add quick sketches to pages %DRAWING...

There are many other plugins, see http://TWiki.org/cgi-bin/view/Plugins

Credits and Acknowledgements

• This training was developed by TWiki:Main.CrawfordCurrie on behalf of Oxamer, one of the companies in the Oxford Gene Technology group.
• Valuable contributions were also received from the TWiki Open Source community; special mentions go to:
  • TWiki:Main.WalterMundt
  • TWiki:Main.SvenDowideit
• The latest version of this presentation is available at TWiki:TWiki.ATasteOfTWiki, where you can also provide feedback

Related topics: WelcomeGuest, TWikiTutorial

Access Keys

What are access keys?

Access keys are keyboard shortcuts which allow the user to navigate around a website or a piece of computer software without having to use a mouse or other pointing device.

What are the advantages of using access keys?

Its an alternative to using a mouse, or other pointing device, and can sometimes be quicker than using a mouse.

Does TWiki have access keys?

TWiki offers access keys in view mode, such as "P" for printable view, and in edit mode, such as "S" for save. The underlined characters in topic action links indicate the access keys.

How do I use access keys?

This depends on the browser you are using:

• Internet Explorer:
  • Press and hold the 'Alt' key
  • Press the required letter
  • Release the keys and press the 'ENTER' key

• Netscape Navigator, Mozilla, or Firefox 1.0:
  • Press and hold the 'Alt' key
  • Press the required letter

• Firefox 2.0 or later:
  • Press and hold both the 'Shift' and the 'Alt' key
  • Press the required letter

• Firefox on Mac:
  • Press and hold the 'Ctrl' key
  • Press the required letter

• Safari on Mac:
  • Press and hold both the 'Ctrl' and the key 'option' key
  • Press the required letter

Related Topics: UserDocumentationCategory

A List of TWiki Administrator Documentation

• AdminSkillsAssumptions: Note: If you are not familiar with Linux system administration, Apache webserver configuration, consider...
• AllowWebCreateByUserMappingManager: There are cases where DENYROOTCHANGE, ALLOWROOTCHANGE, DENYWEBCHANGE, and ALLOWWEBCHANGE are not capable...
• AppendixEncodeURLsWithUTF8: Use internationalised characters within WikiWords and attachment names This topic addresses implemented...
• AutonomousWebs: On a large TWiki site having thousands of webs, each web should be as self service as possible so that...
• CopyingTopics: Browser based copy for individual topics Overview You can use browser based controls to copy a topic...
• CustomUserGroupNotations: Your TWiki site may be depending on a web user authentication mechanism provided in your environment...
• EmptyPlugin: This is an empty plugin. Use it as a template to build your own .TWikiPlugins. This plugin does nothing...
• ForceNewRevision: Normally, if you make subsequent edits within a one hour period (configuration item {ReplaceIfEditedAgainWithin...
• HeadlinesPlugin: This plugin displays RSS and ATOM feeds from news sites. Use it to build news portals that show headline...
• InstalledPlugins: Plugins are mainly user contributed add ons that enhance and extend TWiki features and capabilities....
• InstantEnhancements: These quick enhancements are aimed at improving and customising your TWiki. New TWiki site administrators...
• InterWikis: This topic is part of the InterwikiPlugin and lists all aliases needed to map Inter Site links to external...
• InterwikiPlugin: The InterwikiPlugin links ExternalSite:Page text to a page on an external site based on aliases...
• JQueryPlugin: This plugin packages the popular jQuery and jQuery UI JavaScript libraries. jQuery is a fast...
• LargeSite: There is no limitation with the number of webs and users a TWiki site can have. But there are several...
• MainFeatures: Any web browser: Edit existing pages or create new pages by using any web browser. There is no need...
• ManagingTopics: Browser based rename, move, and delete for individual topics Overview You can use browser based controls...
• ManagingWebs: Adding, renaming and deleting webs are all web based operations. Overview A TWikiSite is divided into...
• MetadataRepository: If you have hundreds or thousands of webs on a TWiki site, web metadata stored in a data repository is...
• MovedSkin: Sometimes a TWiki site is migrated to a new location with a new URL. For convenience users visiting the...
• PatternSkin: . For use in corporate or perhaps in personal websites it should be fairly easy to tune the looks or...
• PatternSkinCss: This page is a reference for all CSS classes used in PatternSkin. PatternSkin uses 4 stylesheets:...
• PlainSkin: The plain skin is used to get the rendered topic text without any page decoration such as side, top or...
• PreviewBackground: Preview looks like the real page, but the links lead to an oops dialog warning users of not yet saved...
• PrintSkin: The print skin, useful to print pages with a small header and footer. Other skins, such as PatternSkin...
• ReadOnlyAndMirrorWebs: This topic describes how to set up read only webs. A read only web can be mirrored from another site...
• RenderListPlugin: Place a % RENDERLIST{ parameters above any bullet list The list can be handcrafted, generated...
• SearchDoesNotWork: I`ve problems with the WebSearch. There is no Search Result on any inquiry. By clicking the Index...
• SetGetPlugin: Use % SET{ to store a JSON object or arbitrary text in a named variable, and reuse it with % GET{...
• SitePermissions: Web Sitemap VIEW CHANGE RENAME Listed DENY ALLOW DENY ALLOW...
• StandardColors: This table can be used to choose a color in of each web. #000000 #000033 #000066 #000099 #0000CC...
• SubwebAndTopicNames: If your TWiki installation has the hierarchical webs feature turned on, you face subtle issues about...
• TWikiAccessControl: Restricting read and write access to topics and webs, by Users and groups TWiki Access Control allows...
• TWikiAddOns: Add functionality to TWiki with extensions not based on the TWiki scripts. Overview An add on runs...
• TWikiContribs: Reusable code that may be used over several plugins and add ons. Overview TWiki contribs extend the...
• TWikiCss: Listing of CSS class names emitted from TWiki core code and standard plugins. Who should read this...
• TWikiDocGraphics: This is the TWiki Documentation Graphics library. The graphics can be used in topics and by web applications...
• TWikiDocumentation: This page contains all documentation topics as one long, complete reference sheet. Related Topics:...
• TWikiDownload: I would like to install TWiki on my server. Can I get the source? Answer: TWiki is distributed under...
• TWikiInstallationGuide: The following is installation instructions for the TWiki 6.1 production release on an Apache web server...
• TWikiNetSkin: The TWikiNetSkin is functional and clean and has corporate appeal. It is the default skin provided with...
• TWikiPlugins: Add functionality to TWiki with readily available plugins; create plugins based on APIs Overview You...
• TWikiReferenceManual: Documentation for webmasters, system administrators, project managers, team leaders, and all other users...
• TWikiScripts: Programs on the TWiki server performing actions such as rendering, saving and renaming topics. The TWiki...
• TWikiSiteTools: Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities...
• TWikiSkinBrowser: You can try out the TWikiSkins currently installed on this system: .skinstable td {border top:2px solid...
• TWikiSkins: A skin overlays regular templates to provide specific look and feel to TWiki screens. Overview TWiki...
• TWikiSystemRequirements: Server and client requirements Low client and server base requirements are core features that keep TWiki...
• TWikiTemplates: Definition of the templates used to render all HTML pages displayed in TWiki Overview Templates...
• TWikiTopics: The basic building block of a TWiki site is called a topic , identified by a unique, hopefully descriptive...
• TWikiUpgradeGuide: This guide covers upgrading from a previous version of TWiki (such as TWiki 5.1) to TWiki 6.1 Overview...
• TWikiUserAuthentication: TWiki site access control and user activity tracking options Overview Authentication, or `logging in...
• TagMePlugin: Plugin to tag wiki content collectively or authoritatively in order to make it easier to find content...
• TimeSpecifications: TWiki recognizes the following formats for date/time strings. For all strings the time is optional....
• TopMenuSkin: The TopMenuSkin adds pulldown menus to the PatternSkin. Screenshot Tob Bar and Menu Structure...
• TwistyPlugin: The TwistyPlugin gives you several options to control the appearance of a twisty: use link text...
• UserMasquerading: This topic describes how to configure your TWiki site for user masquerading. There are cases where it...
• UserSubwebs: TWiki provides each user with their own topic having their information and configuration. You may want...
• UsingMultipleDisks: A TWiki site may reach a point where a single disk drive cannot house all files. Having PubDir on a different...
• ViewTildeJsmith: You can go to a user`s topic by ~loginname instead of /FirstLast. More specifically, if you open http...
• WebLeftBar: 1 Web Users Groups Index Search Changes Notifications...
• WebTopMenu: This topic defines the menu structure of the TWiki web, used by the TopMenuSkin . 1...

Related topics: AdminToolsCategory, CategoryCategory, DeveloperDocumentationCategory, UserDocumentationCategory, UserToolsCategory

Administrator Skills Assumptions

Note: If you are not familiar with Linux system administration, Apache webserver configuration, consider using TWiki:Codev.DownloadTWikiVM - the TWiki Virtual Machine can be installed on Windows or Linux, and makes it possible to get a working TWiki system within 5 minutes (after a fairly big download), ready to use from your browser.

If you need to install TWiki you'll need to either have or learn the following skills (even with DownloadTWikiVM, you'll need these for upgrades). For each of these, the requirement is either pre-existing knowledge/skill, or the willingness to spend significant time learning them:

• Operating system administration: Ability to use Unix/Linux command line tools (or equivalent Windows tools), including ability to move/copy/delete files, change permissions, view web server log files, set environment variables, use a text editor, etc.
• Web server administration: Ability to do basic setup, e.g. ability to edit config files or use GUI configuration tools to enable CGI scripts on a directory.
• Program compilation: Some TWiki extensions may require you to install and compile libraries from source code. You need to be familiar with the use of configure, make, etc.
• Troubleshooting: Ability to perform tests, inspect error logs, talk to technical support (whether in an IT department or web hosting provider) and read documentation in order to help with diagnosing installation problems.

Installing TWiki is not recommended if you only know HTML and web design, unless you are prepared to learn the above, or team up with someone who can handle the installation.

Although the TWikiInstallationGuide is quite complete, there will on occasion be parts that don't work in your local environment (particularly with TWiki:Codev/TWikiOnWebHostingSites, which are sometimes challenging even for those with good OS and web server skills).

There are many excellent resources for learning how to administer your OS and web server, including books, web sites, web forums, IM and e-mail lists.

To get started with Linux, visit HowtoForge.org. HowtoForge offers Linux tutorials, forums to ask questions, and links to sites with information to install and use Linux.

Some resources if you need help, or want to get up and running quickly:

• TWiki:Support/WebHome: Post a question in the TWiki.org support forum. This forum is mainly intended for TWiki related issues, there are other forums if you need help in operating system and web server administration.
• TWiki:Codev/TWikiIRC: Get help from the TWiki community in the #twiki IRC channel.
• TWiki:Codev/TWikiConsultants: Hire a consultant to get you up to speed, maintain or customize your TWiki installation.

Related Topics: AdminDocumentationCategory

Admin Tools

Manage whole TWiki site from one screen.

• Documentation: TWiki Reference Manual
• Site Tools: Configure script, TWikiPreferences, InterWikis, Variables, Doc Graphics
• Manage Users: All users, UserList, Registration, QueryUsers, ResetPassword, ChangePassword, ChangeEmailAddress
• Manage Content: Topics, Webs
• Webs:

  TWiki web	Tools
  Main: TWiki home with users and groups for access control
  Sandbox: Sandbox web to experiment in an open hands-on area
  TWiki: TWiki documentation, welcome guest and user registration

  This table is updated automatically based on WebPreferences settings of the individual webs.
  Legend:		WebHome	WebSearch	WebChanges	WebNotify
  		WebPreferences	WebStatistics	WebTopicList	WebIndex

All Admin Tools Category topics

• BackupRestoreConsole: Related Topics: BackupRestorePlugin, .AdminToolsCategory
• BackupRestorePlugin: This is a solution to backup, restore, and upgrade TWiki sites. It can be used via the browser and on...
• BulkRegistration: Administrators can use this topic to register (i.e. create logins and user topics) for a group of people...
• ChangeEmailAddress: This form is used to change your registered e mail addresses. Your registered e mails are used by TWiki...
• EditUserAccount: WikiName of user: find users Related topics: ManagingUsers, QueryUsers, AdminToolsCategory
• InstalledPlugins: Plugins are mainly user contributed add ons that enhance and extend TWiki features and capabilities....
• ManagingUsers: Register users on your TWiki site; change/reset/install passwords; remove user accounts Some of the...
• ManagingWebs: Adding, renaming and deleting webs are all web based operations. Overview A TWikiSite is divided into...
• QueryUsers: Find users: show all clear Related topics: ManagingUsers, EditUserAccount, AdminToolsCategory...
• ResetPassword: Remember your password? Use 1 instead. Otherwise, use this form to get a new one e mailed to you...
• SiteMap: TWiki is divided up into webs, also known as workspaces or collaboration spaces. Web Description...
• SitePermissions: Web Sitemap VIEW CHANGE RENAME Listed DENY ALLOW DENY ALLOW...
• SiteStatisticsFooter: Legend: Webs Total : Number of webs, excluding template webs Webs Viewed : Number of webs...
• TWikiReferenceManual: Documentation for webmasters, system administrators, project managers, team leaders, and all other users...
• TWikiSiteTools: Utilities for searching, navigation, and monitoring site activity TWiki Site Tools include utilities...
• TemplateWeb: Template webs contain a set of default topics and act as templates when creating a new web. Names of...
• WebHome: The place to learn about TWiki features and perform TWiki system maintenance. TWiki is a flexible,...
• WebLeftBar: 1 Web Users Groups Index Search Changes Notifications...
• WebTopMenu: This topic defines the menu structure of the TWiki web, used by the TopMenuSkin . 1...

Plugins

Administrators can enable and disable plugins using configure.

• SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables or anywhere in topic text
• BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
• ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
• DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
• HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
• JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
• SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
• TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
• TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
• TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
• TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
• WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail

See also: TWikiPlugins

TWiki Version

• TWiki engine: TWiki-6.1.0, Mon, 16 Jul 2018, build 30610
• Plugin API: 6.10

Related topics: AdminDocumentationCategory, CategoryCategory, DeveloperDocumentationCategory, UserDocumentationCategory, UserToolsCategory

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

Allowing Web Creation, Deletion, & Rename by the User Mapping Manager

Motivation

There are cases where DENYROOTCHANGE, ALLOWROOTCHANGE, DENYWEBCHANGE, and ALLOWWEBCHANGE are not capable enough to implement web creation/deletion/rename permission you want. Here are some of those situations.

Making top level web creation and deletion self-service

Usually, to create and delete a top level web, you need to be allowed by ALLOWROOTCHANGE and DENYROOTCHANGE. On a large TWiki site, it's desirable to make top level web creation and deletion self-service.

Allowing users to create and delete their own UserSubwebs

In a large orgnization having thousands or more users, the Main web needs to restrict topic creation to prevent random topics to accumulate. Instead, UserSubwebs are desirable for content accountability. This means that, on the Main web, users are not allowed to create topics but are allowed to create and delete the subweb of their wiki name.

How it works

When a new web is created, the canCreateWeb($cUID, $web) method of the user mapping manager is called if the method exists. If the method returns true, the web is created without checking DENYROOTCHANGE and ALLOWROOTCHANGE (for a top level web) or DENYWEBCHANGE and ALLOWWEBCHANGE (of the parent of a subweb). If the method does not exist or the method returns false, web creation is permitted as usual based on *ROOTCHANGE or *WEBCHANGE.

The method would be written as follows.

sub canCreateWeb {
    my( $this, $cUID, $web ) = @_;
...
}

Similarly, when a web is renamed, the canRenameWeb($cUID, $oldWeb, $newWeb) method of the user mapping manager is called if the method exist. If it returns true, permission check on the parent web is omitted. If the method does not exist or the method returns false, permission check on the parent web is conducted as usual. Then, permission check on the rename destination takes place.

Related Topics: AdminDocumentationCategory, TWikiAccessControl, LargeSite, UserSubwebs

FAQ:

How can I create a simple TWiki Forms based application?

Answer:

TWiki applications help automate workflows you have at the workplace. TWiki has a built-in database that can be used to write custom web applications. These are wiki applications that run in TWiki.

A typical TWiki forms based application consists of the following pages:

• Application home page, typically containing links to other application pages. It may contain also a report showing data records.
• Form definition page, defining the fields of a record. Details in TWikiForms.
• Template page, used as a template for new data records. It is essentially a TWiki page with a form attached to it. Details in TWikiTemplates.
• Header page: Optional page included in each record page to summarize the record.
• Page with an HTML form to create new records.
• Report page(s). Details in VarSEARCH and FormattedSearch.

TWiki.org has a blog post on How to Create a TWiki Application where you can learn the details.

Back to: TWikiFAQ

Related Topics: UserDocumentationCategory

-- Contributors: TWiki:Main.MiyokoTakushima, TWiki:Main.PeterThoeny

Appendix B: Encode URLs With UTF8

Use internationalised characters within WikiWords and attachment names

This topic addresses implemented UTF-8 support for URLs only. The overall plan for UTF-8 support for TWiki is described in TWiki:Codev.ProposedUTF8SupportForI18N.

Current Status

To simplify use of internationalised characters within WikiWords and attachment names, TWiki now supports UTF-8 URLs, converting on-the-fly to virtually any character set, including ISO-8859-*, KOI8-R, EUC-JP, and so on.

Support for UTF-8 URL encoding avoids having to configure the browser to turn off this encoding in URLs (the default in Internet Explorer, Opera Browser and some Mozilla Browser URLs) and enables support of browsers where only this mode is supported (e.g. Opera Browser for Symbian smartphones). A non-UTF-8 site character set (e.g. ISO-8859-*) is still used within TWiki, and in fact pages are stored and viewed entirely in the site character set - the browser dynamically converts URLs from the site character set into UTF-8, and TWiki converts them back again.

System requirements are updated as follows:

• ASCII or ISO-8859-1-only sites do not require any additional CPAN modules to be installed.
• Perl 5.8 sites using any character set do not require additional modules, since CPAN:Encode is installed as part of Perl.
• This feature still works on Perl 5.005_03 as per TWikiSystemRequirements, or Perl 5.6, as long as CPAN:Unicode::MapUTF8 is installed.

The following 'non-ASCII-safe' character encodings are now excluded from use as the site character set, since they interfere with TWiki markup: ISO-2022-*, HZ-*, Shift-JIS, MS-Kanji, GB2312, GBK, GB18030, Johab and UHC. However, many multi-byte character sets work fine, e.g. EUC-JP, EUC-KR, EUC-TW, and EUC-CN. In addition, UTF-8 can already be used, with some limitations, for East Asian languages where EUC character encodings are not acceptable - see TWiki:Codev.ProposedUTF8SupportForI18N.

It's now possible to override the site character set defined in the {SiteLocale} setting in configure - this enables you to have a slightly different spelling of the character set in the server locale (e.g. 'eucjp') and the HTTP header sent to the browser (e.g. 'euc-jp').

This feature should also support use of Mozilla Browser with TWiki:Codev.TWikiOnMainframe (as long as mainframe web server can convert or pass through UTF-8 URLs) - however, this specific combination is not tested. Other browser-server combinations should not have any problems.

Please note that use of UTF-8 as the site character set is not yet supported - see Phase 2 of TWiki:Codev.ProposedUTF8SupportForI18N for plans and work to date in this area.

This feature is complete in TWiki releases newer than February 2004.

Note for skin developers: is no longer required (TWiki:Plugins.InternationalisingYourSkin).

Details of Implementation

URLs are not allowed to contain non-ASCII (8th bit set) characters: http://www.w3.org/TR/html4/appendix/notes.html#non-ascii-chars

The overall plan for UTF-8 support for TWiki is described in two phases in TWiki:/Codev.ProposedUTF8SupportForI18N - this page addresses the first phase, in which UTF-8 is supported for URLs only.

UTF-8 URL translation to virtually any character set is supported as of TWiki Release 01 Sep 2004, but full UTF-8 support (e.g. pages in UTF-8) is not supported yet - this will be phase 2.

The code automatically detects whether a URL is UTF-8 or not, taking care to avoid over-long and illegal UTF-8 encodings that could introduce TWiki:Codev.MajorSecurityProblemWithIncludeFileProcessing (tested against a comprehensive UTF-8 test file, which IE 5.5 fails quite dangerously, and Opera Browser passes). Any non-ASCII URLs that are not valid UTF-8 are then assumed to be directly URL-encoded as a single-byte or multi-byte character set (as now), e.g. EUC-JP.

The main point is that you can use TWiki with international characters in WikiWords without changing your browser setup from the default, and you can also still use TWiki using non-UTF-8 URLs. This works on any Perl version from 5.005_03 onwards and corresponds to Phase 1 of TWiki:Codev.ProposedUTF8SupportForI18N. You can have different users using different URL formats transparently on the same server.

UTF-8 URLs are automatically converted to the current {Site}{Charset}, using modules such as CPAN:Encode if needed.

TWiki generates the whole page in the site charset, e.g. ISO-8859-1 or EUC-JP, but the browser dynamically UTF-8 encodes the attachment's URL when it's used. Since Apache serves attachment downloads without TWiki being involved, TWiki's code can't do its UTF-8 decoding trick, so TWiki URL-encodes such URLs in ISO-8859-1 or whatever when generating the page, to bypass this URL encoding, ensuring that the URLs and filenames seen by Apache remain in the site charset.

TWiki:Codev.TWikiOnMainframe uses EBCDIC web servers that typically translate their output to ASCII, UTF-8 or ISO-8859-1 (and URLs in the other direction) since there are so few EBCDIC web browsers. Such web servers don't work with even ISO-8859-1 URLs if they are URL encoded, since the automated translation is bypassed for URL-encoded characters. For TWiki on Mainframe, TWiki assumes that the web server will automatically translate UTF-8 URLs into EBCDIC URLs, as long as URL encoding is turned off in TWiki pages.

Testing and Limitation

It should work with TWiki:Codev.TWikiOnMainframe. Tested with IE 5.5, Opera 7.11 and Mozilla (Firebird 0.7).

Opera Browser on the P800 smartphone is working for page viewing but leads to corrupt page names when editing pages.

For up to date information see TWiki:Codev.EncodeURLsWithUTF8

Related Topics: AdminDocumentationCategory

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

Making webs autonomous

Motivation

On a large TWiki site having thousands of webs, each web should be as self-service as possible so that TWiki administrators' work is minimized.

Features for web autonomy

You can have the following features by providing specific methods in your user mapping manager class.

• Granting a set of users privilege to do anything on any topic regardless of access control setting. Let's call the set of users "web admins", which is analogous to TWikiAdminGroup members who can do anything to any topic regardless of access control setting.
• Making %WIKIWEBMASTER% and %WIKIWEBMASTERNAME% web dependent. They are used on the Access Denied page and other pages as contact.

Specifying web admins - isAdmin()

The isAdmin() method in a user mapping manager normaly recognizes only one argument, $cUID. (e.g. TWikiUserMapping's) However, the upstream code hands two additional arguments, namely the topic and web names of the topic currently being processed. As such, isAdmin() can be web and topic dependent, which makes it possible to have web admins.

Web specific WIKIWEBMASTER and WIKIWEBMASTERNAME

Optionally, a user mapping manager can have the wikiWebMaster object method taking the following arguments.

• web name
• topic name
• name or email (true means name. false means email)

If the wikiWebMaster does not exist or returns a null string (""), %WIKIWEBMASTER% and %WIKIWEBMASTERNAME% are expanded to {WebMasterName} and {WebMasterEmail} values respectively.

Data source

isAdmin() and wikiWebMaster() need data source to work. The data source needs be outside of the web. Otherwise, there is a possibility of the web admins lose access to the web by some change to the web.

MetadataRepository is one way to have metadata of a web outside the web. In an example on MetadataRepository, a TWiki group specified by the admin field of the web's record is the web admins.

Another way is to put such a data on a topic or topics in the TWiki web and make them editable only by TWiki Administrators.

Related Topics: AdminDocumentationCategory, TWikiAccessControl, MetadataRepository, LargeSite, UserMasquerading

TWiki Backup & Restore Console

Related Topics: BackupRestorePlugin, AdminToolsCategory

Backup & Restore Plugin

Overview

This is a solution to backup, restore, and upgrade TWiki sites. It can be used via the browser and on the command line. This plugin is pre-installed in TWiki-5.1 and later releases. It can be installed in older TWiki releases as oldas TWiki-2001-09-01 (Athens Release) to easily create a backup that can be restored on a new TWiki release. This offers an easy upgrade path for TWiki.

This plugin backs up page data, attachment data, the plugin workspace area, and the TWiki configuration. However, it does not backup the TWiki engine, additional plugins, and skins you might have installed. It is recommended to do a manual backup of the whole twiki directory after installing plugins and skins.

Web-based Operation

The backup and restore functionality is restricted to members of the TWikiAdminGroup.

Once configured, visit the BackupRestoreConsole to:

• Start a new backup.
• Cancel a backup in progress.
• List all backups.
• Delete a backup.
• Restore from a backup.

Screenshot of Backup & Restore Console, overview:

How to Upgrade TWiki

The TWikiUpgradeGuide describes how to manually upgrade TWiki. It is much easier to use the BackupRestorePlugin to do a TWiki upgrade. Follow these steps:

1. Install the BackupRestorePlugin on your old TWiki installation.
2. Create a backup using the TWiki Backup & Restore Console (linked from plugin topic).
   • This creates a backup of name twiki-backup-2024-04-27-12-58.zip in the backup directory (default /tmp).
3. Install the latest TWiki and additional plugins you need.
   • Install the latest BackupRestorePlugin.
4. Transfer the backup zip file to the backup directory of the new TWiki installation (not needed if on same server).
   • The TWiki Backup & Restore Console overview should show the backup of the old TWiki.
5. Use the TWiki Backup & Restore Console to restore the backup to the new TWiki.
   • Check the "Overwrite existing pages" checkbox.
   • Check the "Upgrade restored webs with latest system pages" checkbox.
   • Check the "Restore plugin work area" checkbox.

Screenshot of Backup & Restore Console, detail view of very old TWiki-01-Sep-2001 backup:

Command Line Utility and Cron

The backuprestore utility can be used to create a backup (scheduled or manually), to copy a backup, and to check on the status of the backup process.

Important Notes:

• The utility must run as the same user as the CGI scripts executed by the webserver. This can be apache, nobody, www-data, wwwrun or the like, and depends on the webserver configuration.
• Change to the twiki/bin directory before executing the backuprestore utility.

Scheduled backups can be done with a cron job. Example crontab entry that creates a backup at 10 minutes past midnight every Sunday:

10 0 * * 0 (cd /path/to/twiki/bin; ./backuprestore create_backup >/dev/null 2>&1)

Make sure the plugin is configured properly before creating backups. The backup destination can be local or remote. If remote, the remote server needs to be mounted on the TWiki server via NFS or the like.

Specification

• Configuration:
  • {Plugins}{BackupRestorePlugin}{BackupDir} - Backup destination directory. Default: /tmp.
  • {Plugins}{BackupRestorePlugin}{KeepNumberOfBackups} - keep number of backups (e.g. delete old backups), 0 to keep all. Default: 7
  • {Plugins}{BackupRestorePlugin}{TempDir} - temp directory. Default: /tmp
  • {Plugins}{BackupRestorePlugin}{createZipCmd} - create zip command. Default: /usr/bin/zip -r
  • {Plugins}{BackupRestorePlugin}{listZipCmd} - list zip content command. Default: /usr/bin/unzip -l
  • {Plugins}{BackupRestorePlugin}{unZipCmd} - unzip command. Default: /usr/bin/unzip -o
  • {Plugins}{BackupRestorePlugin}{Debug} - debug flag. Default: 0
• Backup files:
  • Location: Specified by the {Plugins}{BackupRestorePlugin}{BackupDir} configure setting.
  • Name: twiki-backup-2024-04-27-12-58.zip - date based names.
• Backup format of .zip file:
  • data/* - all data and logs.
  • pub/* - all attachments.
  • working/* - working data.
  • working/BackupRestorePlugin/LocalSite.cfg - TWiki configuration file (if found).
  • working/BackupRestorePlugin/LocalLib.cfg - TWiki lib file (if found).
  • working/BackupRestorePlugin/twiki.conf - Apache config file (if found).
  • working/BackupRestorePlugin/version.txt - contains the TWiki version number of the backup. Used to intelligently restore backup to newer TWiki version. Example:
    version: TWiki-5.1.0
short: 5.1
  • working/BackupRestorePlugin/version-long-TWiki-5.1.0.txt - file with TWiki version in filename
  • working/BackupRestorePlugin/version-short-5.1.txt - file with TWiki short-version in filename, name version-short-<major>.<minor>.txt

Syntax Rules

This section is only relevant to plugin developers. This plugin handles a %BACKUPRESTORE{"..."}% variable to perform all web-based operations. The variable is used in the BackupRestoreConsole page.

%BACKUPRESTORE{"..."}% parameters:

This plugin starts a daemon (background process) when a backup is started. Status is checked via Ajax calls. Once the new backup is finished it shows up in the backup table.

Limitations and To-Do

• The zip utility on most platforms has a limitation of 4GB.
  • Fix: Install the latest zip 3.x and unzip 6.x utilities from infozip project on SourceForge.
  • Workaround: Follow the manual upgrade instructions at TWikiUpgradeGuide if you have more data.
• A web-based backup is currently not supported on a native Windows installation of TWiki.
  • Workaround: Use command line utility on Windows.
• Restore is currently not supported on a native Windows installation of TWiki.
  • Workaround: Follow the upgrade instructions at TWikiUpgradeGuide, section Copy your old webs to new TWiki.
• Cancelling a backup or restore might leave some temporary files in the {Plugins}{BackupRestorePlugin}{BackupDir} directory.

• To-do:
  • Option to backup engine (bin, lib, locale, templates, tools).
  • Option to restore log files.

• Ideas for enhancements:
  • In backup, record $TWiki::cfg{Site}{CharSet} setting; on restore do a char-set re-encoding if needed (for example from ISO-8859-15 to UTF-8)
  • Unlock RCS files if restoring from old TWiki.
  • Add incremental backup and restore feature.

License and Bug Reporting

This plugin has been reasonably tested. If you find any issues please file a bug report at TWikibug:BackupRestorePlugin.

This plugin is distributed under GPL (GNU General Public License) in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

Plugin Installation & Configuration

This plugin is pre-installed from TWiki-5.1 on. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Show details Hide details

Plugin Info

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Administrator utility to backup, restore and upgrade a TWiki site

Plugin Author:	TWiki:Main.PeterThoeny, TWiki.org
Copyright:	© 2011-2018 TWiki:Main.PeterThoeny © 2011-2018 TWiki:TWiki.TWikiContributor © 2004, 2005 Simon Flack (for CPAN:IO::CaptureOutput) © 2007, 2008 David Golden (for CPAN:IO::CaptureOutput) © 1997-2011 by Earl Hood and Detlef Pilzecker (for CPAN:Proc::Daemon)
License:	GPL (GNU General Public License)
Plugin Version:	2018-07-10

Show Change History Hide Change History

TWiki Dependency:	$TWiki::Plugins::VERSION 1.0
CPAN Dependencies:	none (Proc::Daemon included as TWiki::Plugins::BackupRestorePlugin::ProcDaemon) (IO::CaptureOutput included as TWiki::Plugins::BackupRestorePlugin::CaptureOutput )
Other Dependencies:	GNU zip and unzip command line utilities
Perl Version:	5.005
TWiki:Plugins.Benchmark:	GoodStyle nn%, FormattedSearch nn%, BackupRestorePlugin nn%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/BackupRestorePlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/BackupRestorePluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/BackupRestorePluginAppraisal

Related Topics: BackupRestoreConsole, TWikiPreferences, TWikiPlugins, AdminToolsCategory

Behaviour Javascript Framework Contrib

Introduction

This contrib packages the third-party Behaviour Javascript event library, available from http://bennolan.com/behaviour/.

Behaviour uses CSS selectors to subscribe to Javascript event handlers. This allows to create clean code, separated from HTML (and well suited to create Javascript based interaction that degrades nicely when Javascript is not available).

From the website:

After all the work of WASP and others to promote clean markup, valid pages and graceful degradation via css - it sucks that we're going back to tag soup days by throwing javascript tags into our html.

The better way to do javascript is to do it unobtrusively. PPK and Simon Willison have been recommending this approach for ages. And it's definitely the way to go. The only problem is that it's a bit of a pain in the ass.

That's why I came up with Behaviour - my solution to unobtrusive javascript behaviours.

How does it work?

Behaviour lets you use CSS selectors to specify elements to add javascript events to. This means that instead of writing:

<li>
 <a onclick="this.parentNode.removeChild(this)" href="#">
  Click me to delete me
 </a>
</li>

You can use:

<ul id="example">
 <li>
  <a href="/someurl">Click me to delete me</a>
 </li>
</ul>

And then use css selectors to select that element and add javascript functions to it.

var myrules = {
 '#example li' : function(el){
  el.onclick = function(){
   this.parentNode.removeChild(this);
  }
 }
};
Behaviour.register(myrules);

Usage

Include the Javascript file:

<script type="text/javascript" src="%PUBURL%/%SYSTEMWEB%/BehaviourContrib/behaviour.js"></script>

In your code you create a "rules" object, with sub-objects for each html element class name or id:

var myrules = {
 '.classname' : function(element) {
  // element event
  element.onclick = function() {
   // code here
  }
 },
 '#id' : function(element) {
  // element event
  element.onclick = function() {
   // code here
  }
 }
};

Or use nested identifiers:

var myrules = {
 '.menu li a' : function(element) {
  element.onclick = function() {
   // code here
  }
 }
};

Apply the rules with:

Behaviour.register(myrules);

Example

If we have a 'normal' link to TWiki Web hometopic: TWiki Web Home, we can use javascript to make it open a popup window. When javascript is not available the link behaviour defaults to opening the page in the current window.

<div id="demoblock" style="padding:1em; width:100px; text-align:center;">
MOUSE OVER ME
</div>

<script type="text/javascript">
// <![CDATA[
var myrules = {
 '#demoblock' : function(el) {
  var defaultColor = '#A3D6F8';
  var highlightColor = '#4A7FB5';

  el.style.backgroundColor = defaultColor;

  el.onmouseover = function() {
   this.style.backgroundColor = highlightColor;
   return false;
  }
  el.onmouseout = function() {
   this.style.backgroundColor = defaultColor;
   return false;
  }
 },
 '#demoblock span' : function(el) {

  var text = el.innerHTML;

  var fisherYates = function (inArray) {
   var i = inArray.length;
   if ( i == 0 ) return false;
   while ( --i ) {
    var j = Math.floor( Math.random() * ( i + 1 ) );
    var tempi = inArray[i];
    var tempj = inArray[j];
    inArray[i] = tempj;
    inArray[j] = tempi;
   }
  }

  var randomize = function(inText) {
   var letters = inText.split('');
   fisherYates(letters);
   return letters.join('');
  }
  el.onmouseover = function() {
   this.innerHTML = randomize(text);
   return false;
  }
  el.onmouseout = function() {
   this.innerHTML = text;
   return false;
  }
 }
};
Behaviour.register(myrules);
// ]]>
</script>

Creates:

Leaking Danger

Behaviour code leaks memory on Windows Explorer prior to version 7. To prevent leaking, set the element variable to null:

var myrules = {
 'table.test td' : function(element) {
  element.onmouseover = function() {
   this.style.backgroundColor = highlightColor;
   return false;
  }
  element = null; // by setting this IE will not leak  
 }
};   
Behaviour.register(myrules);

Development

• Google Groups: Behaviour Javascript Library
• Nabble - Behaviour Javascript Library forum & mailing list archive
• Behaviour2 - update in the making, since 2006

License

Behaviour is freely distributable under the terms of an BSD license. For details see the Behaviour website.

Links

• Behaviour website
• Behaviour Google Group

Installation Instructions

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
  • See the installation supplement on TWiki.org for more information.

• Or, follow these manual installation steps:
  • Download the ZIP file from the extension home on twiki.org (see below).
  • Unzip BehaviourContrib.zip in your twiki installation directory.
  • Set the ownership of the extracted directories and files to the webserver user.
  • Install the dependencies (if any).

Contrib Settings

• Set SHORTDESCRIPTION = Behaviour Javascript event library to create Javascript based interactions that degrade well when Javascript is not available

You can also set the global TWiki variable BEHAVIOURCONTRIB_DEBUG to 1 to make the contrib use uncompressed javascript sources, in the event of problems.

Contrib Info

Author:	TWiki:Main/ArthurClemens
Copyright:	Code: behaviour.js version 1.1 - Copyright (c) Ben Nolan and Simon Willison. TWiki distribution and updates/additions: © TWiki:Main/ArthurClemens. © 2006-2018 TWiki:TWiki/TWikiContributor
License:	BSD for behaviour.js GPL (GNU General Public License) for TWiki BehaviourContrib
Version:	30438 (2018-07-16)
Dependencies:	None
Contrib Version:	2018-07-05
Change History:
2018-07-05:	TWikibug:Item7841: Copyright update to 2018
2016-01-08:	TWikibug:Item7708: Copyright update to 2016
2015-02-16:	TWikibug:Item7604: Switch from GPL v2 to v3
2010-05-15:	TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB
17 Oct 2007	1.3 Replaced "faster code" by other code from Dean Edwards, [[ packed by http://groups.google.com/group/behaviour/browse_thread/thread/85137977bedf5ed/3cf3ba8065d41a8c#3cf3ba8065d41a8c][Raymond Irving]].
02 Jul 2007	1.2 Integrated other faster code by Dean Edwards: faster onload (again).
08 Mar 2007	1.1 Integrated code by Dean Edwards (see Code update version 1.1 with faster DOM queries).
04 Jun 2006	1.0 First Version. Included Behaviour version: 1.1.
Home:	http://TWiki.org/cgi-bin/view/Plugins/BehaviourContrib
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/BehaviourContribDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/BehaviourContribAppraisal

Related Topics: TWikiPreferences

Book View

BookView is an option available from the advanced search topic. It allows you to display the result in "book view", that is, the whole content of topics is shown instead of a topic summary. This allows you to easily see a whole set of pages.

If you want to print a set of pages it is recommended to create a topic that includes a set of topics, which gives more control over formatting and layout for printing.

Related Topics: UserDocumentationCategory, WebSearchAdvanced

-- Contributors: TWiki:Main/PeterThoeny, TWiki:Main/MattWilkie

Bulk Registration

Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch.

Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so no verification is required. Note that the new users are not notified that they have an account. This is so you can prepare and verify the accounts before announcing them. To announce them use the BulkResetPassword feature: this will assign a new random password and notify users.

Bulk Registration usage

If you are administrator, you will take these actions:

1. (First time use) Create new bulk registration topics (see Settings below).
2. In the REGISTERTOPIC topic: create a table of new users. An example table is provided below to copy.
3. Return to this topic and press the button "Bulk Register" to create the new topics.
4. Read %LOGTOPIC% to verify if all has gone well.
5. When you are ready, use the BulkResetPassword page to assign passwords and notify the users of their new accounts.

Below are the details.

Settings

• Define where to pick up the table of users to register
  • Set REGISTERTOPIC = UnprocessedRegistrations
• Use this to define where to log the bulk registration process. It needs to be a topic name in this web.
  • Set LOGTOPIC = %REGISTERTOPIC%Log
• Set this to 1 to make the bulk registration overwrite any existing user topics. By default, existing user topics are left alone.
  • Set OVERWRITEHOMETOPICS = 0

The user table

Example format

<noautolink>
%EDITTABLE{}%
| FirstName | LastName | Email | WikiName |
| Test | User | you@example.com | TestUser |
</noautolink>

Usage:

1. Copy this text to your clipboard
2. Click through and paste this on %REGISTERTOPIC%.
3. Add and customize entries, save table. Note that the first row must not contain bolded entries, so don't apply any formatting.
4. Return here

Customizing user data

You can write additional data to the new user topics. Do this by enhancing the user table with additional field names as table headers.

Any fields you define in this table will end up in the User's topic. If a form (such as UserForm) is attached to NewUserTemplate then the data will go in as META:FIELDS, meaning that you can use SEARCH formfield constructs to search.

If you use the UserForm then ensure that it contains all the fields you define here. Otherwise they will disappear when the user edits their home topic!

Mandatory fields

• WikiName
• FirstName
• LastName

Optional fields

• LoginName - if not set will register with WikiName

Customized table example

<noautolink>
%EDITTABLE{}%
| FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
| Test | User | you@example.com | TestUser | A | B | C |
</noautolink>

%REGISTERTOPIC%

%LOGTOPIC%

Related Topics: AdminToolsCategory

Related Topics: UserDocumentationCategory

List of all Category topics

• AdminDocumentationCategory
• AdminToolsCategory
• DeveloperDocumentationCategory
• UserDocumentationCategory
• UserToolsCategory

CGI Contrib Package

Introduction

This contrib does not add any features to TWiki. Its purpose is to convert Perl's CGI module from being an external dependency to a component of TWiki.

Detailed Documentation

This is the stub module of CgiContrib. Its only purpose is to expose the version number of CGI under its expected package name, so that the TWiki dependency checking mechanism will find it.

Settings

• Set SHORTDESCRIPTION = CGI version 4.13 from CPAN:CGI

Installation Instructions

This contrib ships with TWiki (versions 6.0.2 or newer). You should only consider installing it yourself if 1) you experience problems with CGI in your installation, and 2) installing or upgrading this is recommended by the TWiki community as a fix for your problems.

You do not need to install anything on the browser to use this contrib package. These instructions are for the administrator who installs the package on the server where TWiki is running.

Show details Hide details

Contrib Info

Author:	TWiki:Main.TWikiContributor
Copyright:	© 2015-2018 Peter Thoeny; © 2015-2018 TWiki Contributors
License:	GPL (GNU General Public License)
Dependencies:	Name Version Description HTML::Entities >0 Required by CGI module
Version:	2018-07-05
Change History:
2018-07-05:	TWikibug:Item7841: Copyright update to 2018
2016-01-08:	TWikibug:Item7708: Copyright update to 2016
2015-11-29:	Initial version
Home:	http://TWiki.org/cgi-bin/view/Plugins/CgiContrib
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/CgiContribDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/CgiContribAppraisal

Related Topics: TWikiContribs, SystemInformationVariables

Change E-mail Address

This form is used to change your registered e-mail addresses. Your registered e-mails are used by TWiki for sending you e-mails, including notifications of password changes. The addresses you register via this form are kept secret and will not be published anywhere on this site.

Security Note: You really ought to register a valid e-mail address. If TWiki can't find a registered e-mail for you in the secret database, it will look in your user topic for a line like this:

   * Set Email = user@example.com

If your old e-mail addresses are all invalid (you can't receive mail there any more) and you have forgotten your password, please contact support-l@caida.org for help.

Related topics: ChangePassword, ResetPassword, UserToolsCategory, AdminToolsCategory

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

Class Method

A ClassMethod is a method that must be called relative to the containing class object. This normally only applies to the new method used to create new object instances. For example,

package Telecoms

ClassMethod new()

my $mobile = new Telecoms();

my $mobile = Telecoms->new();

Related Topics: StaticMethod, ObjectMethod, DeveloperDocumentationCategory

Color Picker Plugin

Page contents

• Introduction
• Using the color picker in TWikiForms
• Using the color picker in an HTML form
• Using the color picker with disabled plugin
• Installation Instructions
• Plugin Info

Introduction

This TWiki plugin packages the Farbtastic color picker, which is a jQuery plugin developed by Steven Wittens of Acko.net. The package adds a color picker to TWiki forms and TWiki applications.

Using the color picker in TWikiForms

This package adds a color type to TWikiForms:

Type	Description	Size	Value
color	Single-line text box and a color picker to pick a color. The color can also be typed into the text box, such as #123456. An attribute of type="popup" shows a button that, when clicked, opens a color picker popup.	Text box width in number of characters	Initial (default) color

Example form definition:

Note: The type="popup" attribute requires TWiki-6.0.2 or later.

Using the color picker in an HTML form

You can also use the color picker directly in your HTML forms, without having to write any code. Just include this in the topic text:

<form action="...">
%COLORPICKER{ name="text_color" size="12" value="#123456" class="twikiInputField" }%
<form>

Test: (this only works if the ColorPickerPlugin is installed and enabled)

Using the color picker with disabled plugin

It is also possible to use the color picker in HTML forms with disabled ColorPickerPlugin:

%INCLUDE{ "%SYSTEMWEB%.ColorPickerPlugin" section="code" }%
<form action="...">
%INCLUDE{ "%SYSTEMWEB%.ColorPickerPlugin" section="picker" NAME="demo_color" SIZE="12" VALUE="#123456" EXTRA="class=\"twikiInputField\"" }%
</form>

Test: (this works only if the ColorPickerPlugin is installed and disabled)

Installation Instructions

This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Show details Hide details

Plugin Info

• Set SHORTDESCRIPTION = Color picker for use in TWiki forms and TWiki applications

Author:	TWiki:Main.PeterThoeny, TWiki.org
Copyright:	© 2007 Steven Wittens, Acko.net for Farbtastic jQuery plugin © 2010-2018 TWiki:Main.PeterThoeny and TWiki:TWiki.TWikiContributor for TWiki ColorPickerPlugin
Sponsor:	Wave Systems Corp. for type parameter
License:	GPL (GNU General Public License)
Dependencies:	JQueryPlugin (pre-installed)
Version:	2018-07-05

Show Change History Hide Change History

2018-07-05:	TWikibug:Item7841: Copyright update to 2018
2016-01-08:	TWikibug:Item7708: Copyright update to 2016
2015-01-10:	TWikibug:Item7604: Switch to GPL v3
2014-12-29:	TWikibug:Item7601: Implement new type="popup" parameter for popup color widget
2014-12-20:	TWikibug:Item7601: New type parameter to set the type of color widget
2014-12-11:	TWikibug:Item7577: TWiki form field type with configure attributes, color type supports form, onblur, onfocus, onchange, onselect, onmouseover, onmouseout, pattern, placeholder, spellcheck, style, tabindex, title, translate
2013-02-15:	TWikibug:Item7148: Fix for color picker not working if initial value of TWiki forms field of type color is empty
2013-01-09:	TWikibug:Item7091: Dependency clarification; use TWISTY for installation instructions
2012-12-03:	TWikibug:Item7020: Add VarCOLORPICKER with category; doc improvements
2012-08-11:	TWikibug:Item6837: Doc fixes; updated installation instructions
2011-06-11:	TWikibug:Item6725: Change global package variables from "use vars" to "our"
2010-11-30:	TWikibug:Item6610: Rewrite ColorPickerContrib into ColorPickerPlugin
2010-11-27:	TWikibug:Item6609: In TWikiForms type table, automatically list the color form field type defined in this contrib -- TWiki:Main.PeterThoeny
2010-11-26:	TWikibug:Item6606: Complete rewrite of contrib using Farbtastic color picker -- TWiki:Main.PeterThoeny
2006-10-27:	Initial version of ColorPickerContrib by TWiki:Main.FlavioCurti using Colorpicker by Norman Timmler (inlet media e.K., Hamburg, Germany)

Home:	http://TWiki.org/cgi-bin/view/Plugins/ColorPickerPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/ColorPickerPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/ColorPickerPluginAppraisal

Related Topics: VarCOLORPICKER, TWikiPreferences, TWikiForms, TWikiPlugins

Comment Plugin

Related topics: CommentPluginTemplates, CommentPluginExamples

Features

Inserts an edit box into the page that allows users to type in and save comments. Comments can be made

• in different formats (as defined by a template),
• in both forward and reverse chronological order,
• signed or unsigned, dated or undated (as defined by a template),
• in other topics, or other positions within the current topic.

Syntax

Write %COMMENT{attributes}% anywhere in a TWiki topic.

• A %COMMENT% without parameters shows a simple text box.
• A %COMMENT{}% can handle the following parameters:

  Parameter	Description	Default
  type	This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see customization. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences.	"below"
  default	Default text to put into the textarea of the prompt.
  target	Name of the topic to add the comment to	the current topic
  location	Regular expression specifying the comment location in the target topic. Read carefully the CommentPlugin documentation!
  mode	For compatibility with older versions only, synonymous with type
  nonotify	Set to "on" to disable change notification for target topics	"off"
  noform	Set to "on" to disable the automatic form that encloses your comment block - remember to insert <form> tags yourself! See CommentPluginExamples#noform for an example.	"off"
  nopost	Set to "on" to disable insertion of the posted text into the topic.	"off"
  remove	Set to "on" to remove the comment prompt after the first time it is clicked.	"off"
  button	Button label text	"Add comment"
  emailto	Send comment by email. Use comma "," to seperate multiple email addresses. This feature is disabled by default. To enable this feature, please set up "$TWiki::cfg{Plugins}{CommentPlugin}{EmailEnabled} = 1;".

(See also additional attributes)

Positioning the comment

%COMMENT supports several ways to specify where a comment should be inserted in the target topic. This is referred to as the location of the comment.

Location relative to %COMMENT tag

The default location is the %COMMENT tag itself. For example:

%COMMENT{type="below"}%

Location relative to a TWiki anchor

The target attribute may specify a web, and may also specify an anchor within the target topic; for example,

%COMMENT{type="above" target="%USERSWEB%.PersonalRemarks#InsertHere"}%

Location relative to an arbitrary text string

Getting more sophisticated, you can also specify a regular expression for the target location using the location parameter. The target topic is searched for the regular expression, and the comment inserted relative to the string that the search matched. For example,

%COMMENT{type="above" location="Flights of Fancy"}%

Warning of course, if a user's comment contains the string "Flights of Fancy" they may and up changing the location for the next comment! Also, if you use a tag in the location, then you've just inserted another tag in the page that contains the %COMMENT! So be very careful how you specify the RE for location. Note that the RE is matched using perl "multiple line" mode, so ^ and $ match the start of a line and the end of a line respectively.
Also note that you cannot have the text location=" just before the location.

I look forward to someone leveraging this feature to create - for example - threaded conversations using %COMMENT.

If you specify an anchor and a location, the anchor will be ignored.

Default templates

Templates are used to define the "comment style" i.e. how comments appear in the page. The default is to add comments in "Blog like" style using bulleted lists, with the most recent comment at the top, but many other styles are available such as tables or Wiki thread mode comments. It is easy to define your own customer styles as well.

A set of default comment templates are shipped with the plugin - see also CommentPluginTemplates:

Your local installation may add more template types as well - see Customization, below.

Customization

Customization of the comment plugin requires

• familiarity with HTML forms
• some familiarity with the TWiki templating language.

To define a comment type, you have to provide two simple template definitions in the template file; one for the prompt box, and one for the generated output. If we have a template type "mytype", these are named PROMPT:mytype and OUTPUT:mytype respectively. See comments.tmpl in the templates directory for examples.

The plugin picks up these template definitions from a standard TWiki template file, templates/comments.tmpl. This allows different templates to be defined for different TWiki skins.

Defining custom templates

By default, templates/comments.tmpl includes the topic CommentPluginTemplate, which contains all the shipped standard templates and in turn includes TWiki.UserCommentsTemplate that can include non-standard customizations.

This allows for several levels of customization:

1. To override all default templates, everywhere, change comments.tmpl to include a different topic (this customization will be lost next time you upgrade, though).
2. To add site-wide local template customizations, add them to UserCommentsTemplate (create if it does not exist yet). You can redefine the standard templates here if you want, and your definitions will override the standard definitions.
3. To override templates on a web-by-web basis, add a topic UserCommentsTemplate to the web (this will replace TWiki.UserCommentsTemplate)
4. To override templates for a specific skin, add them to TWiki.UserComments<Skin>Template (where <Skin> is the name of the skin with the first letter capitalized, e.g. Pattern)

Per topic custom comment template

You can also define a comment template in a topic, by passing the topic location with a templatetopic parameter. For example:

%COMMENT{type="blogpost" templatetopic="BlogPostCommentTemplate" target="CommentPlugin" button="Add comment" }%

templatetopic accepts topic or web.topic syntax. See an example in CommentPluginExamples#TemplateTopic.

If you use any topic other than UserCommentTemplate, it is critically important that you include this line at the end of your comment template topic:

%TMPL:INCLUDE{"%SYSTEMWEB%.CommentPlugin"}%

Templates are picked up by following the standard TWiki rules for locating template files. Note that you can use %TMPL:INCLUDE% to include other files of templates.
Note that from TWiki release 4.1.0 leading and trailing whitespace is no longer stripped. This means that when you upgrade to TWiki 4.1.X you may need to remove the first line break in your custom comment templates. See TWikiReleaseNotes04x01 for more information.

Customization example

Provide both a PROMPT and an OUTPUT definition:

%TMPL:DEF{PROMPT:myComment}%%TMPL:P{promptbox}%%TMPL:END%
%TMPL:DEF{OUTPUT:myComment}%%TMPL:P{outputoneliner}%%POS:TOP%
%TMPL:END%

Call your custom comment with:

%COMMENT{type="myComment"}%

The PROMPT template

The PROMPT template defines the contents of an HTML form that is used to capture the comment. This form invokes the comment generator when submitted. Parameters to the comment generator are defined using standard HTML input fields, such as input, textarea and select. The user enters values for these parameters, and these are then available when the OUTPUT template is expanded, in the form of %URLPARAM%s.

Note that you must define a "submit" button if you want the form to work!

Only the input fields of the form need be defined. The plugin automatically generates the <form> and </form> tags, with these two exceptions:

1. The COMMENT has a noform="on" parameter. In this case, the PROMPT template has to specify the form tags and some additional hidden input fields. See CommentPluginExamples#noform example.
2. The PROMPT template contains %COMMENTFORMSTART% and %COMMENTFORMEND%, which gives control over where to add the form tags and the hidden input fields:
   • %COMMENTFORMSTART% - HTML form start tag
   • %COMMENTFORMEND% - hidden input fields and HTML form end tag

The latter feature can be used to define a PROMPT template that contains more than one form, such as a comment plugin prompt form, and a second form with a "notify authors" button (see TWiki:Plugins.NotifyAuthorsPlugin).

Example PROMPT template with two forms:

%TMPL:DEF{PROMPT:two_form_demo}%
%COMMENTFORMSTART% <!-- form start tag -->
<textarea %DISABLED% rows="%rows|5%" cols="%cols|80%" name="comment"></textarea>
<input %DISABLED% type="submit" value="%button|Add comment%" class="twikiButton" />
%COMMENTFORMEND% <!-- hidden input fields and form end tag -->
%NOTIFYAUTHORS% <!-- second form with notify authors button -->
%TMPL:END%

Providing attribute values

If an attribute is given to the %COMMENT tag that is not one of the standard attributes, then that attribute is taken as the name of a parameter to be expanded in the PROMPT template. Expressions in the template of the form %param|default% (e.g. %rows|3%, %button|Push me%) are expanded to the values given in the %COMMENT. For example, if the PROMPT template 'example' contains:

<textarea rows=%rows|3% cols="%cols|50%" value="%tval|Rubbish%">

%COMMENT{type="example" cols="75"}%

<textarea rows="3" cols="75" value="Rubbish">

Special variables

As well as support for all the usual TWiki variables in templates, the following special variables are supported in the PROMPT definition:

EXPERT Note that when a comment is saved, the TWiki save script is invoked on the target topic, with a number of parameters provided by the comment form. Normally the CommentPlugin will provide these fields in the form, but experts can also provide the fields themselves in order to get finer control over what is submitted, or you might want to define your own HTML forms that do comment submission. The parameters that the CommentPlugin recognises are as follows:

<form method="post" action="%SCRIPTURL{save}%/TWiki/CommentPlugin">
<input type="submit" value="I Approve" />
<input type="hidden" name="comment_action" value="save" />
<input type="hidden" name="comment_type" value="bottom" />
<input type="hidden" name="comment" value="I Approve" />
</form>

Customization example with custom form template

Write a custom form in a topic.

• In the form set the location of the prompt with %COMMENTPROMPT%; the prompt will be positioned here.
• In %COMMENT use parameter noform="on"
• In %COMMENT use parameter templatetopic to point to the topic with the form template

Example form:

%TMPL:DEF{FORM:example}%
<form method="post" action="%SCRIPTURL{save}%/%BASEWEB%/%BASETOPIC%" enctype="application/x-www-form-urlencoded" name="examplecomment" id="examplecomment">
<input type="hidden" name="redirectto" value="%BASEWEB%.%BASETOPIC%" />
%COMMENTPROMPT%
</form>
%TMPL:END%

Example comment:

%COMMENT{noform="on" type="example" templatetopic="Sandbox.CommentPluginTemplateExample" target="CommentPlugin" button="Add comment" }%

The OUTPUT template

The OUTPUT template defines the format for the text that actually gets embedded into the topic. All the usual TWiki variables are available in the PROMPT definition, but note that they get expanded when the comment is inserted in the text, so time, date and username will refer to the time and date when the comment was made, and the user who made it.

There are also four position tags that are used to indicate where the comment should be placed, relative to the location defined in the %COMMENT tag:

Note that these position tags are obviously mutually exclusive. If you define more than one, the result is undefined. If none is present, the default is taken from the plugin setting COMMENTPLUGIN_DEFAULT_TYPE

All the usual TWikiVariables that can be used in a topic template can also be used in an OUTPUT template. See TWikiVariables for details.

Plugin Settings

Show details Hide details

Plugin Installation Instructions

This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Show details Hide details

Plugin Info

• Set SHORTDESCRIPTION = Quickly post comments to a page without an edit/preview/save cycle.

Plugin Author:	TWiki:Main.CrawfordCurrie http://www.c-dot.co.uk inspired by the work of TWiki:Main.DavidWeller and TWiki:Main.PeterMasiar
Copyright:	© 2004, TWiki:Main.CrawfordCurrie; © 2009 TWiki:Main.SopanShewale; © 2004-2018 TWiki:Main.PeterThoeny; © 2004-2018 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2018-07-05

Show Change History Hide Change History

Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/CommentPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/CommentPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/CommentPluginAppraisal

Related Topics: CommentPluginTemplates, CommentPluginExamples, TWikiPreferences, TWikiPlugins

• Top comment output 2 -- TWikiContributor - 26 Nov 2006
• Top comment output 1 -- TWikiContributor - 26 Nov 2006

CommentPlugin examples

CommentPlugin templates

Default

Default comment output 1

-- TWikiContributor - 26 Nov 2006

Default comment output 2

-- TWikiContributor - 26 Nov 2006

%COMMENT{}%

top

%COMMENT{type="top"}%

bottom

%COMMENT{type="bottom"}%

above

Above comment output 1

-- TWikiContributor - 26 Nov 2006

Above comment output 2

-- TWikiContributor - 26 Nov 2006 %COMMENT{type="above"}%

below

%COMMENT{type="below"}%

• Below comment output 2 -- TWikiContributor - 26 Nov 2006
• Below comment output 1 -- TWikiContributor - 26 Nov 2006

bulletabove

• Bullet above comment output 1
• Bullet above comment output 2

threadmode

Threadmode comment output 1

-- TWikiContributor - 26 Nov 2006

Threadmode comment output 2

-- TWikiContributor - 26 Nov 2006 %COMMENT{type="threadmode"}%

belowthreadmode

%COMMENT{type="belowthreadmode"}%

TWikiContributor - 26 Nov 2006 - 12:09

Belowthreadmode comment output 2

TWikiContributor - 26 Nov 2006 - 12:09

Belowthreadmode comment output 1

tableprepend

%COMMENT{type="tableprepend"}%

tableappend

after

• After comment output 1 -- TWikiContributor - 26 Nov 2006
• After comment output 2 -- TWikiContributor - 26 Nov 2006

action

(requires TWiki:Plugins/ActionTrackerPlugin)

%ACTION{ due="1-Dec-2007" creator="Main.TWikiContributor" uid="000001" state="open" created="26-Nov-2006" who="Main.TWikiContributor" }% <<EOF Action comment output 1 - Created by TWikiContributor, 26 Nov 2006 - 10:58 EOF %ACTION{ due="1-Jan-2008" creator="Main.TWikiContributor" uid="000003" state="open" created="26-Nov-2006" who="Main.TWikiContributor" }% <<EOF Action comment output 2 - Created by TWikiContributor, 26 Nov 2006 - 10:58 EOF %COMMENT{type="action"}%

table

toctalk

26 Nov 2006 - 00:45 TWikiContributor: Toctalk output summary 1

26 Nov 2006 - 11:09 TWikiContributor: Toctalk output summary 2

%COMMENT{type="toctalk"}%

bookmark

• Bookmark output link label
• TWiki - Bookmark output comment

return

Comments:

Warning: Can't find topic TWiki.COMMENT_TOPIC

noform

templatetopic

TWikiContributor - 08 Apr 2007:

templatetopic example comment output 1

• Bottom comment output 1 -- TWikiContributor - 26 Nov 2006
• Bottom comment output 2 -- TWikiContributor - 26 Nov 2006

Templates for CommentPlugin

See CommentPlugin: Customisation for help.

While this topic can be viewed as a TWiki topic, it is used by the CommentPlugin as a template file - see TWikiTemplates. The important content in here is in the verbatim blocks. The rest of the topic is just comments.

See CommentPluginExamples to view rendered templates.

A note on security with the URLPARAM variable: Comments are passed along via URL parameters. They are safely encoded by default to reduce the exposure to cross-site scripting. To preserve user text "as is", and at the cost of security, you can turn off encoding by using encode="off" in the URLPARAM variable. The newline="" parameter of URLPARAM gets encoded with the same encoding as the actual URL parameter. In TWiki 5.0 and later you can specify newline="$br" to add a <br />, regardless of the encoding used.

Put your local templates into UserCommentsTemplate (create if it does not exist yet). Local templates defined in that topic will override templates defined below.

Template definitions

Templates used in rest of file

%TMPL:DEF{promptbox}%<div class="commentPlugin commentPluginPromptBox" style="margin: 5px 0;">%IF{ "istopic '%SYSTEMWEB%.ScrollBoxAddOn'" then="$percntINCLUDE{ \"%SYSTEMWEB%.ScrollBoxAddOn\" section=\"scroll_box_engine\" }$percnt $percntINCLUDE{ \"%SYSTEMWEB%.ScrollBoxAddOn\" section=\"static_box_start\" boxstyle=\"padding: 7px; width: auto; background-color: #f6f6fb;\" }$percnt" }% <div><textarea %DISABLED% rows="%rows|5%" cols="%cols|80%" name="comment" class="twikiTextarea" wrap="soft" style="width: 100%" onfocus="if(this.value=='%MESSAGE%')this.value=''" onblur="if(this.value=='')this.value='%MESSAGE%'">%MESSAGE%</textarea></div><div style="padding: 5px 0 0 0;"><input %DISABLED% type="submit" value="%button|Add comment%" class="twikiButton" /></div> %IF{ "istopic '%SYSTEMWEB%.ScrollBoxAddOn'" then="$percntINCLUDE{ \"%SYSTEMWEB%.ScrollBoxAddOn\" section=\"static_box_end\" }$percnt" }%</div><!--/commentPlugin-->%TMPL:END%

%TMPL:DEF{outputoneliner}%   * %URLPARAM{"comment"}% -- %WIKIUSERNAME% - %DATE%%TMPL:END%

See rendered template Default

User templates

top

%TMPL:DEF{PROMPT:top}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:top}%%TMPL:P{outputoneliner}%%POS:TOP%
%TMPL:END%

See rendered template top

bottom

%TMPL:DEF{PROMPT:bottom}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:bottom}%%POS:BOTTOM%%TMPL:P{outputoneliner}%%TMPL:END%

See rendered template bottom

above

%TMPL:DEF{PROMPT:above}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:above}%%POS:BEFORE%%TMPL:P{OUTPUT:threadmode}%%TMPL:END%

See rendered template above

bulletabove

%COMMENT{type="bulletabove" inputsize="20"}%

%TMPL:DEF{PROMPT:bulletabove}%<input class="twikiInputField" name="bullet_above_item" id="bullet_above_item" type="text" size="%inputsize|40%" value="%URLPARAM{"bullet_above_item"}%" />&nbsp;<input %DISABLED% type="submit" value="%button|Add item%" class="twikiButton" />%TMPL:END%

%TMPL:DEF{OUTPUT:bulletabove}%   * %URLPARAM{"bullet_above_item"}%%POS:BEFORE%
%TMPL:END%

See rendered template bulletabove

threadmode

%TMPL:DEF{PROMPT:threadmode}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:threadmode}%%POS:BEFORE%

%URLPARAM{"comment"}%

%STARTSECTION{ type="expandvariables" }%%IF{ "defined 'BUBBLESIGNATUREFORMAT'" then="$percntBUBBLESIGNATUREFORMAT$percnt" else="-- $percntWIKIUSERNAME$percnt - $percntDATE$percnt" }%%ENDSECTION{ type="expandvariables" }%
%TMPL:END%

See rendered template threadmode

belowthreadmode

%TMPL:DEF{PROMPT:belowthreadmode}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:belowthreadmode}%%POS:AFTER%
---++++ %WIKIUSERNAME% - %SERVERTIME%

%URLPARAM{"comment"}%

%TMPL:END%

See rendered template belowthreadmode

below

%TMPL:DEF{PROMPT:below}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:below}%%POS:AFTER%%TMPL:P{outputoneliner}%
%TMPL:END%

See rendered template below

tableprepend

%TMPL:DEF{PROMPT:tableprepend}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:tableprepend}%%POS:AFTER%| %URLPARAM{"comment" newline="$br"}% | %WIKIUSERNAME% | %SERVERTIME% |
%TMPL:END%

See rendered template tableprepend

tableappend

%TMPL:DEF{PROMPT:tableappend}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:tableappend}%%POS:BEFORE%| %URLPARAM{"comment" newline="$br"}% | %WIKIUSERNAME% | %SERVERTIME% |
%TMPL:END%

See rendered template tableappend

after: Add before the comment box, after the last comment

%TMPL:DEF{PROMPT:after}%%TMPL:P{promptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:after}%%NOP%%TMPL:P{outputoneliner}%
%POS:BEFORE%%TMPL:END%

See rendered template after

action

%TMPL:DEF{PROMPT:action}%

%TABLE{databg="#ffffff" tableborder="0" cellborder="0"}%
|        <label for="action_who">Action for</label>| <input class="twikiInputField" name="action_who" id="action_who" type="text" size="50" value="%URLPARAM{"who"}%" /> |
| <label for="action_due">Due date</label>| <input class="twikiInputField" name="action_due" id="action_due" type="text" size="30" value="%URLPARAM{"due"}%" /> |
|    <label for="action_comment">Comment</label>| <textarea %DISABLED% rows="%rows|3%" cols="%cols|50%" name="action_comment" id="action_comment" class="twikiInputField" wrap="soft" onfocus="if(this.value=='%MESSAGE%')this.value=''" onblur="if(this.value=='')this.value='%MESSAGE%'">%MESSAGE%</textarea> |
|| <input %DISABLED% type="submit" class="twikiButton" value="Add action" /> |
%TMPL:END%

%TMPL:DEF{OUTPUT:action}%%POS:BEFORE%%AC%NOP%TION{who="%URLPARAM{"action_who"}%" due="%URLPARAM{"action_due"}%"}% %URLPARAM{"action_comment" newline="<br />"}%<br />- Created by %WIKIUSERNAME%, %SERVERTIME%
%ENDAC%NOP%TION%
%TMPL:END%

See rendered template action

table

%TMPL:DEF{PROMPT:table}%
%TABLE{databg="#ffffff" tableborder="0" cellborder="0"}%
|        <label for="comment_date">Date</label>| <input class="twikiInputField" %DISABLED% type="text" size="40" name="comment_date" id="comment_date" /> |
|        <label for="comment_city">City</label>| <input class="twikiInputField" %DISABLED% type="text" size="40" name="comment_city" id="comment_city" value="" /> |
|| <input %DISABLED% type="submit" class="twikiButton" value="%button|Add entry%" /> |
%TMPL:END%

%TMPL:DEF{OUTPUT:table}%%POS:BEFORE%| %URLPARAM{"comment_date"}% | %WIKIUSERNAME% | %URLPARAM{"comment_city"}% |
%TMPL:END%

See rendered template table

toctalk

%TMPL:DEF{PROMPT:toctalk}%
%TABLE{databg="#ffffff" tableborder="0" cellborder="0"}%
|        <label for="comment_summary">Summary</label>| <input class="twikiInputField" %DISABLED% type="text" size="40" name="comment_summary" id="comment_summary" /> |
|        <label for="toctalk_comment_text">Message</label>| <textarea %DISABLED% rows="%rows|3%" cols="%cols|50%" name="toctalk_comment_text" id="toctalk_comment_text" class="twikiInputField" wrap="soft" onfocus="if(this.value=='%MESSAGE%')this.value=''" onblur="if(this.value=='')this.value='%MESSAGE%'">%MESSAGE%</textarea> |
|| <input %DISABLED% type="submit" value="%button|Add%" class="twikiButton" /> |
%TMPL:END%

%TMPL:DEF{OUTPUT:toctalk}%
%POS:BEFORE%---++++ %SERVERTIME% %WIKIUSERNAME%: %URLPARAM{"comment_summary"}%
%POS:BEFORE%%URLPARAM{"toctalk_comment_text" }%
%POS:BEFORE%
%TMPL:END%

See rendered template toctalk

bookmark

%TMPL:DEF{PROMPT:bookmark}%
%TABLE{databg="#ffffff" tableborder="0" cellborder="0"}%
|        <label for="comment_url">Url</label>| <input class="twikiInputField" %DISABLED% type="text" size="40" name="comment_url" id="comment_url" value="http://" /> |
| <label for="comment_link">Link label</label>| <input class="twikiInputField" %DISABLED% type="text" size="40" name="comment_link" id="comment_link" /> |
|    <label for="bookmark_comment_text">Comment</label>| <input class="twikiInputField" %DISABLED% type="text" size="40" name="bookmark_comment_text" id="bookmark_comment_text" value="%MESSAGE%" /> |
|| <input %DISABLED% type="submit" value="%button|Add bookmark%" class="twikiButton" /> |
%TMPL:END%

%TMPL:DEF{OUTPUT:bookmark}%%POS:BEFORE%   * [[%URLPARAM{"comment_url" encode="entity"}%][%URLPARAM{"comment_link" encode="entity"}%]] %IF{" '%URLPARAM{"bookmark_comment_text" encode="entity"}%' = '' " then="" else="- "}%%URLPARAM{"bookmark_comment_text" encode="entity"}%
%TMPL:END%

See rendered template bookmark

return

%TMPL:DEF{returnpromptbox}%
<input type="hidden" name="redirectto" value="%BASEWEB%.%BASETOPIC%" />
%TMPL:P{promptbox}%
%TMPL:END%

%TMPL:DEF{PROMPT:return}%%TMPL:P{returnpromptbox}%%TMPL:END%

%TMPL:DEF{OUTPUT:return}%%POS:BEFORE%%TMPL:P{OUTPUT:threadmode}%%TMPL:END%

See rendered template return

Include UserComments

Including UserComments:

%TMPL:INCLUDE{"UserComments"}%

Copying Topics

Browser-based copy for individual topics

Overview

You can use browser-based controls to copy a topic within the same web or to another web. The specified topic is copied in its entirety including revision history and attachments.

How to Copy a Topic

1. Click on [More topic actions] (bottom right of page) on the topic to be changed, then, in the new screen, on [Copy topic]. You can now copy in one operation
2. To web: Select the target web if other than the current web
3. To topic: Enter the new topic name - default is current name
4. Overwrite: By default, you are warned if the destination topic exists and the copying is aborted. If you check the overwrite checkbox, existence of the target topic doesn't prevent copying from taking place
5. Disable fix links: This checkbox appears only if DISABLEFIXLINKCHECKBOX preference variable is 'on'. Checking this checbox makes the copying operation bypass fixing WikiWord links in the copy destination topic if copy is done across webs
6. Click on [Copy]: the topic will be copied.

Overwriting destination

If the overwrite checkbox is checked and the destination topic does exist, the destination topic is deleted before copying. This is like deleting the destination topic from browser before the copying operation - moving the destination topic to the Trash web.

This means that if you cannot delete the destination topic due to access restriction, copying fails even if you check the overwrite checkbox.

Link fixing in the destination

Fixing links in the copy destination topic such as from SomeLink to Otherweb.SomeLink is usually desirable so that links in the copied topic still point to the same target.

You may clone a set of topics linking each other to a different web. In that case, link fixing is not desirable. For example, let's assume WebOne has TopicA, TopicB, and TopicC linking each other. Also assume that you want to clone the set of topics to WebTwo. If you copy those topics ordinarily, WebTwo.TopicA has links to WebOne.TopicB and WebOne.TopicC. This is not desired. WebTwo.TopicA must havve links to WebTwo.TopicB and WebTwo.TopicC.

This kind of situation does occur but is rather rare and esoteric. To avoid unnecessary confusion, the disable fix links checkbox is supressed by default. DISABLEFIXLINKSCHECKBOX needs to be set 'on' for the checkbox to show up.

Effect of User Access Settings

User permissions affect the 'copy' functions in various ways. To copy a topic, you need VIEW access to that topic. In addition, you need CHANGE access to the destination topic. If the destination topic already exists and hence is overwritten, RENAME access to the destination is also needed so that it can be deleted before copying. See TWikiAccessControl for information on setting up access permissions.

Related Topics: UserDocumentationCategory, AdminDocumentationCategory

Custom User/Group Notations

Your TWiki site may be depending on a web user authentication mechanism provided in your environment. And your users are well accustomed to the user IDs of that environment.

You may have an LDAP server or Active Directory, which defines groups. And your TWiki site may be connected that directory server using LdapNgPlugin.

This topic discusses how to have such custom notations and use them for access control and change notification setting.

Assumption

Here's the basic assumption of this topic.

• The user and/or group information is stored in a kind of directory system and TWiki can make a query to it using LdapNgPlugin or something else
• A directory look-up web application is provided and people can look up user and/or group information there

To make the discussion concrete, let's assume the following custom notations.

User notation: USER:user-id

TWiki gets an authenticated user ID in $ENV{REMOTE_USER} from a mechanismm provided by the environment. A user can be represented as USER:user-id in addition to a wikiname. USER:user-id in a topic becomes a hyper link to the directory look-up page of the user.

Group notation: LDAPGROUP:group-name

Groups are defined in LDAP and they are represented as LDAPGROUP:group-name. There is no wikiname corresponding to those groups. LDAPGROUP:group-name in a topic becomes a hyper link to the directory look-up page of the group.

LDAP groups may be used in parallel to group defined by TWiki topics.

How they are used

For access control, the notations are used as follows.

   * Set ALLOWWEBVIEW = LDAPGROUP:team-foo, USER:bar

   * 'LDAPGROUP:team-foo'
   * 'USER:bar'

What's needed

To make use of the notations mentioned above for access control and change notification setting, you need to have the following.

• A custom user mapping manager and set $TWiki::cfg{UserMappingManager} accordingly.
• A custom plug-in to render those notations to proper hyper links If a string in the notation refers to a non-existent user or group, it needs to be rendered similarly to a missing topic but clicking it must not end up creating a new topic

How to implement a custome user mapping

Custom user mapping 101

If you simply utilize authenticated user IDs provided by the environment and map to wikinames and map wikinames to user IDs, you don't provide custom notations, and you stick to groups defined by TWiki topics, then you don't have to do a lot with your custom mapping manager. Creating a subclass of TWikiUserMapping and implementing the following methods is enough.

• handlesUser()
  A wikiname can be handed as a login name. In such a case, false needs to be returned.
• login2cUID()
• getLoginName()
• getWikiName()
• findUserByEmail()
• getEmails()
• findUserByWikiName()

You don't have to have a plug-in for user wikinames, but it's nice if you have it. Because under the assumption, user registration in TWiki is not needed, hence many users leave their user topics (Main.FirstLast) not created. Consequently, quite a few users' wikinames remain broken links.

If user wikinames are converted into links to directory look-up web site's entries, you don't see such broken links of user wikinames. In addition, the wikiname of non-existent user is rendered like a broken link, it's even better.

Since TWiki depends on user accounts provided by the environment, TWiki don't and cannot deal with user password. As such, $TWiki::cfg{PasswordManager} is set to 'none'.

Full-fledged user mapping manager

In addition to above, the following have to be done to make a user mapping manager full-fledged and support the notations mentioned above.

handlesUser()

login2cUID()

Needs to return a proper cUID when USER:user-id is given.

eachGroupMember()

When LDAPGROUP:group-name is handed, the method needs to return the list whose only element is the one handed.

Otherwise, expand the group.

isGroup()

In addition to groups defined by TWiki topics, LDAPGROUP:group-name needs to yield true.

isInGroup()

In addition to groups defined by TWiki topics, LDAPGROUP:group-name needs to be taken care of.

getEmails()

When LDAPGROUP:group-name is handed, the method needs to return the email address corresponding to the LDAP group.

findUserByWikiName()

When USER:user-id is handed, the method needs to return the corresponding cUID.

Related Topics: AdminDocumentationCategory, TWikiAccessControl, MailerContrib

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

Date Picker Plugin

Page contents

• Introduction
• Use Date Picker in TWikiForms
• Use Date Picker in HTML Forms
• Detailed Documentation
• Installation Instructions
• Plugin Info

Introduction

The DatePickerPlugin handles an input field with a pop-up calendar to select a date for use in TWiki forms and TWiki applications. The plugin is based on the Mishoo JSCalendar, a DHTML pop-up calendar. The date format can be customized.

ATTENTION: This plugin replaces the JSCalendarContrib. The DatePickerPlugin and older versions of the JSCalendarContrib do not coexist. Before using the DatePickerPlugin, uninstall the JSCalendarContrib, or upgrade the contrib to version 2012-12-12 or later.

Use Date Picker in TWikiForms

This package adds a date type to TWikiForms:

Type	Description	Size	Value
date	Text input field and a button next to it to pick a date from a pop-up calendar. The date can also be typed into the text box.	Text box width in number of characters	Initial (default) date

Example form definition:

Use Date Picker in HTML Forms

You can also use the date picker directly in your HTML forms, without having to write any code. Just include this in the topic text:

<form action="...">
%DATEPICKER{ name="Start_date" value="2024-04-27" }%
<form>

Test: (this only works if the DatePickerPlugin is installed and enabled)

Detailed Documentation

Show details Hide details

use TWiki::Plugins::DatePickerPlugin;
...
my $fromDate = TWiki::Plugins::DatePickerPlugin::renderForEdit(
   'from', '2012-12-31');
my $toDate = TWiki::Plugins::DatePickerPlugin::renderForEdit(
   'to', undef, '%Y');

use TWiki::Plugins::DatePickerPlugin;
...

sub commonTagsHandler {
  ....
  # Add styles and javascript for the date picker & enable 'showCalendar'
  TWiki::Plugins::DatePickerPlugin::addToHEAD( 'twiki' );

  my $cal = CGI::image_button(
      -name => 'img_datefield',
      -onclick =>
       "return showCalendar('id_datefield','%Y %b %e')",
      -src=> TWiki::Func::getPubUrlPath() . '/' .
             TWiki::Func::getTwikiWebname() .
             '/DatePickerPlugin/img.gif',
      -alt => 'Calendar',
      -align => 'middle' )
    . CGI::textfield(
      { name => 'date', id => "id_datefield" });
  ....
}

Installation Instructions

You do not need to install anything on the browser to use this plugin. These instructions are for the administrator who installs the plugin on the TWiki server.

Show details Hide details

Plugin Info

• Set SHORTDESCRIPTION = Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins

Author:	TWiki:Main.PeterThoeny, TWiki.org
Copyright:	© See the Mishoo documentation for Mishoo JSCalendar; © 2012 Wave Systems Corp. for TWiki DatePickerPlugin rewrite; © 2004-2018 TWiki:Main.PeterThoeny for TWiki DatePickerPlugin; © 2004-2018 TWiki:TWiki.TWikiContributor for TWiki DatePickerPlugin
Sponsor:	Wave Systems Corp.
License:	GPL (GNU General Public License)
Dependencies:	JQueryPlugin (pre-installed)
Version:	2018-07-05
Change History:
2018-07-05:	TWikibug:Item7841: Copyright update to 2018
2016-01-08:	TWikibug:Item7708: Copyright update to 2016
2015-01-10:	TWikibug:Item7604: Switch to GPL v3
2014-12-11:	TWikibug:Item7577: TWiki form field type with configure attributes -- TWiki:Main.PeterThoeny
2013-09-04:	TWikibug:Item7333: Support more input field attributes, such as accesskey, pattern and required -- TWiki:Main.PeterThoeny
2013-01-09:	TWikibug:Item7091: Use TWISTY in detailed documentation section, installation instructions -- TWiki:Main.PeterThoeny
2012-12-20:	TWikibug:Item7077: Initial version, partly based on work of TWiki:Plugins.JSCalendarContrib -- TWiki:Main.PeterThoeny
Home:	http://TWiki.org/cgi-bin/view/Plugins/DatePickerPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/DatePickerPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/DatePickerPluginAppraisal

Related Topics: VarDATEPICKER, TWikiPreferences, TWikiForms, TWikiPlugins

FAQ:

How do I delete or rename a topic?

Answer:

These two questions are answered together because often when you think you want to delete a page, more often it makes sense to rename the page to contain more context, e.g. rename it to include the date.

You can rename, move and delete topics directly from your browser. Moving lets you transfer a topic from one web to another. The soft delete moves a topic to the special Trash web, where it's hidden but can be "undeleted" with system administrator access.

Click [More topic actions] on the control bar at the bottom of the page you want to change, then choose [Rename/move topic], and make your changes to that screen. There's a link that launches to the ManagingTopics reference page in a pop-up window.

NOTE: The configuration of your site and your own access permissions determine whether you can access these functions.

Note for site administrators: To remove a topic permanently move it to the Trash web, then with file-level access, delete the .txt and .txt,v files manually from /twiki/data/Trash.

Back to: TWikiFAQ

Related Topics: UserDocumentationCategory

FAQ:

How do I delete or rename a file attachment?

Answer:

You can move and delete attachments directly from your browser. Moving lets you transfer an attachment from one topic to another. The soft delete moves an attachment to the special TrashAttachment topic in the Trash web, where it's hidden but can be "undeleted" with system administrator access. Please note that you cannot rename an attachment in the current TWiki release.

Click on [action] on the file in the FileAttachment table, then in the Update attachment screen choose [Move attachment], and make your changes to that screen.

NOTE: The configuration of your site and your own access permissions determine whether you can access these functions.

Note for system administrators: To remove an attachment permanently move it to the Trash.TrashAttachment topic, then with file-level access, delete the file attachment and its ,v repository file manually from twiki/pub/Trash/TrashAttachment.

Back to: TWikiFAQ

Related Topics: UserDocumentationCategory

A List of TWiki Developer Documentation

• ClassMethod: A ClassMethod is a method that must be called relative to the containing class object. This normally...
• EmptyPlugin: This is an empty plugin. Use it as a template to build your own .TWikiPlugins. This plugin does nothing...
• FileAttribute: Each FileAttachment in a Topic has an attribute string. At present only the hidden attribute is supported...
• InterwikiPlugin: The InterwikiPlugin links ExternalSite:Page text to a page on an external site based on aliases...
• JQueryPlugin: This plugin packages the popular jQuery and jQuery UI JavaScript libraries. jQuery is a fast...
• ObjectMethod: An ObjectMethod is a method that must be called relative to a previous constructed object of the class...
• PageRenderingProcess: Overview of how TWiki works To achieve a goal in TWiki either by making use of existing features or...
• RenderListPlugin: Place a % RENDERLIST{ parameters above any bullet list The list can be handcrafted, generated...
• SetGetPlugin: Use % SET{ to store a JSON object or arbitrary text in a named variable, and reuse it with % GET{...
• StaticMethod: A StaticMethod is a method in a package that can be called without reference to an object of the package...
• TWikiAddOns: Add functionality to TWiki with extensions not based on the TWiki scripts. Overview An add on runs...
• TWikiContribs: Reusable code that may be used over several plugins and add ons. Overview TWiki contribs extend the...
• TWikiCss: Listing of CSS class names emitted from TWiki core code and standard plugins. Who should read this...
• TWikiDocGraphics: This is the TWiki Documentation Graphics library. The graphics can be used in topics and by web applications...
• TWikiHistory: New Features and Enhancements of TWiki Release 6.1 Bug Fixes 59 bugs fixed in TWiki...
• TWikiMetaData: Additional topic data, program generated or from TWikiForms, is stored embedded in the topic text using...
• TWikiPlugins: Add functionality to TWiki with readily available plugins; create plugins based on APIs Overview You...
• TWikiReferenceManual: Documentation for webmasters, system administrators, project managers, team leaders, and all other users...
• TWikiScripts: Programs on the TWiki server performing actions such as rendering, saving and renaming topics. The TWiki...
• TWikiSkins: A skin overlays regular templates to provide specific look and feel to TWiki screens. Overview TWiki...
• TWikiTemplates: Definition of the templates used to render all HTML pages displayed in TWiki Overview Templates...
• TagMePlugin: Plugin to tag wiki content collectively or authoritatively in order to make it easier to find content...
• TwistyPlugin: The TwistyPlugin gives you several options to control the appearance of a twisty: use link text...
• WebLeftBar: 1 Web Users Groups Index Search Changes Notifications...
• WebTopMenu: This topic defines the menu structure of the TWiki web, used by the TopMenuSkin . 1...

Related topics: AdminDocumentationCategory, AdminToolsCategory, CategoryCategory, UserDocumentationCategory, UserToolsCategory

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

Note: No new revision is created in case you save the same topic again within a certain time frame (default is one hour). You only need to checkmark the "Minor change, don't notify" checkbox the first time, because subsequent save operations within that period do not notify users.

Note: The initial state of the checkbox can be set to on with the DONTNOTIFYCHECKBOX preferences variable. See TWikiPreferences for more.

Related Topics: UserDocumentationCategory

FAQ:

Why does the topic revision not increase when I edit a topic?

Answer:

The same topic revision will be used when you save a topic again within a certain time frame (one hour by default). This is to prevent unnecessary topic revisions when you do several edit cycles in a row. To force a new revision when saving again within a short time frame, check the "Force new revision" checkbox below the [Save] button.

Note that a new revision is created if another person edits the same topic, regardless of the time.

TWiki administrators can modify the time frame with the {ReplaceIfEditedAgainWithin} configure setting.

Back to: TWikiFAQ

Related Topics: UserDocumentationCategory

Edit Table Plugin

Introduction

Edit TWiki tables in place, using edit fields and drop down boxes, without having to edit the complete topic.

Simply add an [ Edit table ] button to an existing table by writing %EDITTABLE{}% directly above the table. This can be added to tables that are formatted with TablePlugin: add the EDITTABLE variable just above or below the TABLE tag. It can also be used without any TABLE tag.

Customize entry fields by specifying the format: use a text field, a drop down box, a date field, radio buttons or checkboxes.

Multiple tables per topic are editable, but only one at a time can be edited.

ATTENTION: This plugin version depends on the new TWiki:Plugins.DatePickerPlugin; the JSCalendarContrib is no longer needed and must be upgraded or uninstalled. Before uninstalling JSCalendarContrib check if you use any extensions that depend on the JSCalendarContrib as described in that contrib package.

Per Table Settings

Add a %EDITTABLE{...}% variable just before an existing table to make it editable, or add the variable anywhere in a topic to start a new table.

• Supported attributes:

  Attribute	Comment	Default
  header	Specify the header format of a new table like "|*Food*|*Drink*|". Useful to start a table with only a button	(no header)
  format	The format of one column when editing the table. A cell can be a text input field, or any of these edit field types: • Text input field (1 line):   | text, <size>, <initial value> | • Textarea input field:   | textarea, <rows>x<columns>, <initial value> | • Drop down box:   | select, <size>, <option 1>, <option 2>, etc* |   * only one item can be selected • Radio buttons:   | radio, <size*>, <option 1>, <option 2>, etc |   * size indicates the number of buttons per line in edit mode • Checkboxes:   | checkbox, <size*>, <option 1>, <option 2>, etc |   * size indicates the number of checkboxes per line in edit mode • Fixed label:   | label, 0, <label text> | • Row number:   | row, <offset> | • Date:   | date, <size>, <initial value>, <DHTML date format*> |   * see Date Field Type	"text, 16" for all cells
  changerows	Rows can be added and removed if "on" Rows can be added but not removed if "add" Rows cannot be added or removed if "off"	CHANGEROWS plugin setting
  quietsave	Quiet Save button is shown if "on", hidden if "off"	QUIETSAVE plugin setting
  include	Other topic defining the EDITTABLE parameters. The first %EDITTABLE% in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place.	(none)
  helptopic	Topic name containing help text shown below the table when editing a table. The %STARTINCLUDE% and %STOPINCLUDE% variables can be used in the topic to specify what is shown.	(no help text)
  headerislabel	Table header cells are read-only (labels) if "on"; header cells can be edited if "off" or "0"	"on"
  editbutton	Set edit button text, e.g. "Edit this table"; set button image with alt text, e.g. "Edit table, %PUBURL%/%SYSTEMWEB%/TWikiDocGraphics/edittopic.gif"; hide edit button at the end of the table with "hide" (Note: Button is automatically hidden if an edit button is present in a cell)	EDITBUTTON plugin setting
  buttonrow	Set to top to put the edit buttons above the table.	bottom
  javascriptinterface	Use javascript to directly move and delete row without page refresh. Enable with "on", disable with "off".	JAVASCRIPTINTERFACE plugin setting
  redirectto	Set up a return page after saving changes. e.g By setting redirectto="%BASEPAGE%", you can return to base page if your editable table is included by another page.	(none)

Using TWiki Variables in the Format Parameter

By default, variables in <initial value> (of text input field) and <label text> (of fixed label) get expanded when a new row is added. This can be used for example to add a timestamp to a label. You can escape characters with format tokens if you do not want that.

Any TWiki variable inside a table cell will be preserved. For instance, %TOPIC% will not get expanded to the current topic name.

The format tokens are the same as with FormattedSearch:

Date Field Type

The date field type allows one to choose a date with a popup calendar. Popup calendar works with all modern browsers. The date picker button is inactive if the browser cannot support the popup calendar or if Javascript is disabled.

The date format can be defined; the default is taken from the {Plugins}{DatePickerPlugin}{Format} configure setting. Date specifiers are described in DatePickerPlugin. Example format for ISO date: format="| date, 10, , %Y-%m-%d |".

Per Cell Settings

An individual edit field type can be defined for each table cell. Place an %EDITCELL{ "type, ..." }% variable at the end of the cell content. This is useful to override the per column %EDITTABLE{ format="..." }% settings, or to create tables with key/value rows. All edit field types of the format="..." parameter are supported. For example, to define a text field, type: | cell content %EDITCELL{ "text, 20" }% |

It is also possible to place the edit button inside a cell instead of default location below the table. Type | %EDITCELL{ "editbutton, 1, Edit this table" }% | to show a button, or | %EDITCELL{ "editbutton, 1, Edit table, Image-URL" }% | to show a button image with alternate text.

Note: The %EDITCELL{ }%=variable cannot be used by itself; place an =%EDITTABLE{ }%=variable at the beginning of a table where you want to use =%EDITCELL{ }% variables.

Table Buttons

Examples

Line before table: %EDITTABLE{ format="| row, -1 | text, 20, init | select, 1, one, two, three, four | radio, 3,:-),:-I,:-( | label, 0, %SERVERTIME{"$day $mon $year $hour:$min"}% |" changerows="on" }% %EDITTABLE{ format="| row, -1 | text, 20, init | select, 1, one, two, three, four | radio, 3,:-),:-I,:-( | label, 0, 27 Apr 2024 12:58 |" changerows="on" }%

Note: Please do not save this example table! Use TWiki:Sandbox.EditTablePluginTesting if you want to try out this Plugin

If this plugin is installed you will see an [ Edit table ] button above; if you were to click on it (please don't, use TWiki:Sandbox.EditTablePluginTesting for testing) you get this form:

Nr	Text field	Drop down	Mood	Timestamp
1		one two three four		26 Jun 2002 12:30
2		one two three four		27 Jun 2002 12:40

The following example shows a simple table with key/value rows. The default edit field type for the value column is a text field. This is overloaded by a selector for the Gender, and a date picker for the DOB. This is typically used by TWiki applications where new topics with tables are created based on a template topic.

You type:	You get:	Table in edit mode:
%TABLE{"headerrows="1"}% %EDITTABLE{ format="| label | text, 40 |" changerows="off" }% |*Key*|*Value*| | Name: | John Smith | | Gender: | M %EDITCELL{select, 1, , F, M}% | | DOB: | 1999/12/31 %EDITCELL{date, 10}% | | City: | New York |

Limitations and Known Issues

• This Plugin does not support TWiki table formatting like Multi-span cells (e.g. | ... ||) and cell justification (e.g. |  centered  |   right |)
• There is a performance issue when editing a large table, say, with more then 50 rows
• You cannot put two %EDITTABLE{}% statements on the same line in the source
• You can include %-vars now in select values, by quoting them with <nop>, as in %<nop>X% for %X%, say for instance:
  select,1,%<nop>X%,%<nop>Y%

Plugin Settings

Show details Hide details

Installation Instructions

This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.

Show details Hide details

Plugin Info

Plugin Author:	Arthur Clemens, TWiki:Main.PeterThoeny
Copyright:	© 2008 Arthur Clemens; © 2002-2018 TWiki:Main.PeterThoeny, TWiki.org; © 2002-2018 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2018-07-05

Show Change History Hide Change History

Dependencies:	Name Version Description TWiki::Plugins::DatePickerPlugin >=0 Required. Used to select a date when using type date.
Perl Version:	5.0
TWiki:Plugins/Benchmark:	GoodStyle 98%, FormattedSearch 98%, EditTablePlugin 95%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/EditTablePlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/EditTablePluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/EditTablePluginAppraisal

Related Topics: VarEDITTABLE, DatePickerPlugin, TWikiPreferences, TWikiPlugins

Manage Users: Edit User Account

Note: User management is reserved to TWiki administrators.

Related topics: ManagingUsers, QueryUsers, AdminToolsCategory

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

Empty TWiki Plugin

Introduction

This is an empty plugin. Use it as a template to build your own TWikiPlugins. This plugin does nothing, but is ready to be extended and used.

To create your own plugin:

• Copy file lib/TWiki/Plugins/EmptyPlugin.pm to <name>Plugin.pm and customize the plugin. Add your own code; remove all handlers you do not plan to use.
• Create a <name>Plugin documentation topic in the TWiki web. Do so by visiting http://twiki.org/cgi-bin/view/Plugins/PluginPackageHowTo and starting a new topic to get the default plugin topic text (don't save the topic on twiki.org yet). Customize your plugin topic to your needs.
• Please consider contributing your plugin back to the TWiki community by publishing it in the Plugins web on twiki.org.
• See details in TWikiPlugins.

Syntax Rules

%EXAMPLEVAR{"..."}%

Examples

• %EXAMPLEVAR{}% expands to: %EXAMPLEVAR{}%

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

Show details Hide details

Plugin Info

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Empty Plugin used as a template for new plugins

Plugin Author:	TWiki:Main.AndreaSterbini, TWiki:Main.PeterThoeny, TWiki:Main.CrawfordCurrie
Copyright:	© 2001-2018 TWiki:Main.PeterThoeny, TWiki.org; © 2001-2018 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2018-05-07

Show Change History Hide Change History

TWiki Dependency:	$TWiki::Plugins::VERSION 1.4
Dependencies:	%$DEPENDENCIES
Plugin Benchmark:	GoodStyle 99%, FormattedSearch 99%, EmptyPlugin 99%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/EmptyPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/EmptyPluginAppraisal

Related Topics: VarEXAMPLEVAR, TWikiPlugins, TWikiFuncDotPm, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

-- TWikiGuest - 2024-04-27

TWiki Variables » Search » Category: Web Home

Related Topics: TWikiVariables, TWikiVariablesSearch, TWikiVariablesQuickStart

File Attachments

Each topic can have one or more files of any type attached to it by using the Attach screen to upload (or download) files from your local PC. Attachments are stored under revision control: uploads are automatically backed up; all previous versions of a modified file can be retrieved.

What Are Attachments Good For?

File Attachments can be used to archive data, or to create powerful customized groupware solutions, like file sharing and document management systems, and quick Web page authoring.

Document Management System

• You can use Attachments to store and retrieve documents (in any format, with associated graphics, and other media files); attach documents to specific TWiki topics; collaborate on documents with full revision control; distribute documents on a need-to-know basis using web and topic-level access control; create a central reference library that's easy to share with an user group spread around the world.

File Sharing

• For file sharing, FileAttachments on a series of topics can be used to quickly create a well-documented, categorized digital download center for all types of files: documents; graphics and other media; drivers and patches; applications; anything you can safely upload!

Web Authoring

• Through your Web browser, you can easily upload graphics (or sound files, or anything else you want to link to on a page) and place them on a single page, or use them across a web, or site-wide.
  • NOTE: You can also add graphics - any files - directly, typically by FTP upload. This requires FTP access, and may be more convenient if you have a large number of files to load. FTP-ed files can't be managed using browser-based Attachment controls. You can use your browser to create TWikiVariables shortcuts, like this %H% = .

Uploading Files

• Click on the Attach link at the bottom of the page. The Attach screen lets you browse for a file, add a comment, and upload it. The uploaded file will show up in the File Attachment table.
  • NOTE: The topic must already exist. It is a two step process if you want to attach a file to a non-existing topic; first create the topic, then add the file attachment.
  • TWiki is capable of getting up to 10 files per upload session. Whether you can actually upload multiple files in one go from web user interface depends on skin.
  • Any type of file can be uploaded. Some files that might pose a security risk are renamed, ex: *.php files are renamed to *.php.txt so that no one can place code that would be read in a .php file.
  • The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it, again you can copy the previous upload path into the Local file field.
  • TWiki can limit the file size. This is defined by the %ATTACHFILESIZELIMIT% variable of the TWikiPreferences, currently set at 10000 KB.
    • It's not recommended to upload files greater than a few hundred K through a browser. Large files can be extremely slow-loading, and often time out. Use an FTP site for large file uploads.
• Automatic attachments:
  • When enabled, all files in a topic's attachment directory are shown as attachments to the topic - even if they were directly copied to the directory and never attached by using an 'Attach' link. This is a convenient way to quickly "attach" files to a topic without uploading them one by one; although at the cost of losing audit trail and version control.
  • To enable this feature, set the {AutoAttachPubFiles} configuration option.
  • NOTE: The automatic attachment feature can only be used by an administrator who has access to the server's file system.

Downloading Files

• Click on the file in the File Attachment table.

• NOTE: There is no access control on individual attachments. If you need control over single files, create a separate topic per file and set topic-level access restrictions for each.

Moving Attachment Files

An attachment can be moved between topics.

• Click Manage on the Attachment to be moved.
• On the control screen, select the new web and/or topic.
• Click Move. The attachment and its version history are moved. The original location is stored as topic Meta Data.

Deleting Attachments

Move unwanted Attachments to web Trash, topic TrashAttachment.

Linking to Attached Files

• Once a file is attached it can be referenced in the topic. Example:
  1. Attach file: Sample.txt
  2. Edit topic and enter: %ATTACHURL%/Sample.txt
  3. Preview: %ATTACHURL%/Sample.txt text appears as: /twiki/pub/TWiki/FileAttachment/Sample.txt, a link to the text file.

• To reference an attachment located in another topic, enter:
  • %PUBURLPATH%/%WEB%/OtherTopic/Sample.txt (if it's within the same web)
  • %PUBURLPATH%/Otherweb/OtherTopic/Sample.txt (if it's in a different web)

• Attached HTML files and text files can be inlined in a topic. Example:
  1. Attach file: Sample.txt
  2. Edit topic and write text: %INCLUDE{"%ATTACHURL%/Sample.txt"}%
     • Content of attached file is shown inlined.
     • Read more about INCLUDE in TWikiVariables

• GIF, JPG and PNG images can be attached and shown embedded in a topic. Example:
  1. Attach file: Smile.gif
  2. Edit topic and write text: %ATTACHURL%/Smile.gif
  3. Preview: text appears as /twiki/pub/TWiki/FileAttachment/Smile.gif, an image.

File Attachment Contents Table

Files attached to a topic are displayed in a directory table, displayed at the bottom of the page, or optionally, hidden and accessed when you click Attach.

Topic attachments

I	Attachment	History	Action	Size	Date	Who	Comment
txt	Sample.txt		manage	0.1 K	2000-07-22 - 19:37	TWikiContributor	Just a sample
gif	Smile.gif		manage	0.1 K	2000-07-22 - 19:38	TWikiContributor	Smiley face

File Attachment Controls

Clicking on a Manage link takes you to a new page that looks a bit like this (depending on what skin is selected):

• The first table is a list of all attachments, including their attributes. An h means the attachment is hidden, it isn't listed when viewing a topic.

• The second table is all the versions of the attachment. Click on View to see that version. If it's the most recent version, you'll be taken to an URL that always displays the latest version, which is usually what you want.
  • To change the comment on an attachment, enter a new comment and then click Change properties. Note that the comment listed against the specific version will not change, however the comment displayed when viewing the topic does change.
  • To hide/unhide an attachment, enable the Hide file checkbox, then click Change properties.

File names

File systems tend to be liberal about characters used in file names. But there are characters which may cause problems if they are used in a file name of a TWiki attachment. As such, when TWiki saves an uploaded file attachment, it's saved as a file whose name is cleansed to avoid problems. Specifically:

• Space are replaed by underscores
• The .txt extension is appended to some filenames for security reasons
• Characters such as ~, $, @, % are removed
• Non-ASCII characters are deleted

Known Issues

• Unlike topics, attachments are not locked during editing. As a workaround, you can change the comment to indicate an attachment file is being worked on - the comment on the specific version isn't lost, it's there when you list all versions of the attachment.
• Attachments are not secured by default. Anyone can read them if they know the name of the web, topic and attachment. Ask your TWiki administrator if TWiki is configured to secure attachments.

Related Topics: UserDocumentationCategory, TWikiAccessControl

Related Topics: UserDocumentationCategory, DeveloperDocumentationCategory

The "Force new revision" checkbox is a way to force it to create a separate revision each time you save.

The TWiki.TWikiPreferences variable FORCENEWREVISIONCHECKBOX controls whether this is checked by default or not.

On a related note, you can force every save to be a new revision number by setting {ReplaceIfEditedAgainWithin} to 0.

Related Topics: UserDocumentationCategory, AdminDocumentationCategory

Formatting Tokens

TWiki defines some standard special tokens that can be used to replace characters in some parameters - notably those to FormattedSearch and IfStatements - to defer evaluation of the parameter until later. These special tokens are often called "escapes", because they allow the character to "escape" from its normal meaning.

If you ever find yourself needing to escape an escape, you can use $dollar to escape the leading dollar, thus: $dollarpercnt.

Related topics: FormattedSearch, IfStatements, QuerySearch, TWikiForms

TWiki Formatted Search

Inline search feature allows flexible formatting of search result

The default output format of a %SEARCH{...}% is a table consisting of topic names and topic summaries. Use the format="..." parameter to customize the search result. The format parameter typically defines a bullet or a table row containing variables, such as %SEARCH{ "food" format="| $topic | $summary |" }%. See %SEARCH{...}% for other search parameters, such as separator="".

Syntax

Three parameters can be used to customize a search result:

1. header="..." parameter

Use the header parameter to specify the header of a search result. It should correspond to the format of the format parameter. This parameter is optional.
Example: header="| *Topic:* | *Summary:* |"

Variables that can be used in the header string:

2. format="..." parameter

Use the format parameter to specify the format of one search hit.
Example: format="| $topic | $summary |"

Variables that can be used in the format string: